service-fabric-client-apis — quality + safety report

---
name: service-fabric-client-apis
description: "Service Fabric Client APIs API skill. Use when working with Service Fabric Client APIs for $, Nodes, ApplicationTypes. Covers 234 endpoints."
version: 1.0.0
generator: lapsh
---

# Service Fabric Client APIs
API version: 6.5.0.36

## Auth
No authentication required.

## Base URL
http://localhost:19080

## Setup
1. No auth setup needed
2. GET /$/GetClusterManifest -- verify access
3. POST /$/GetClusterHealth -- create first GetClusterHealth

## Endpoints

234 endpoints across 14 groups. See references/api-spec.lap for full details.

### $
| Method | Path | Description |
|--------|------|-------------|
| GET | /$/GetClusterManifest | Get the Service Fabric cluster manifest. |
| GET | /$/GetClusterHealth | Gets the health of a Service Fabric cluster. |
| POST | /$/GetClusterHealth | Gets the health of a Service Fabric cluster using the specified policy. |
| GET | /$/GetClusterHealthChunk | Gets the health of a Service Fabric cluster using health chunks. |
| POST | /$/GetClusterHealthChunk | Gets the health of a Service Fabric cluster using health chunks. |
| POST | /$/ReportClusterHealth | Sends a health report on the Service Fabric cluster. |
| GET | /$/GetProvisionedCodeVersions | Gets a list of fabric code versions that are provisioned in a Service Fabric cluster. |
| GET | /$/GetProvisionedConfigVersions | Gets a list of fabric config versions that are provisioned in a Service Fabric cluster. |
| GET | /$/GetUpgradeProgress | Gets the progress of the current cluster upgrade. |
| GET | /$/GetClusterConfiguration | Get the Service Fabric standalone cluster configuration. |
| GET | /$/GetClusterConfigurationUpgradeStatus | Get the cluster configuration upgrade status of a Service Fabric standalone cluster. |
| GET | /$/GetUpgradeOrchestrationServiceState | Get the service state of Service Fabric Upgrade Orchestration Service. |
| POST | /$/SetUpgradeOrchestrationServiceState | Update the service state of Service Fabric Upgrade Orchestration Service. |
| POST | /$/Provision | Provision the code or configuration packages of a Service Fabric cluster. |
| POST | /$/Unprovision | Unprovision the code or configuration packages of a Service Fabric cluster. |
| POST | /$/RollbackUpgrade | Roll back the upgrade of a Service Fabric cluster. |
| POST | /$/MoveToNextUpgradeDomain | Make the cluster upgrade move on to the next upgrade domain. |
| POST | /$/Upgrade | Start upgrading the code or configuration version of a Service Fabric cluster. |
| POST | /$/StartClusterConfigurationUpgrade | Start upgrading the configuration of a Service Fabric standalone cluster. |
| POST | /$/UpdateUpgrade | Update the upgrade parameters of a Service Fabric cluster upgrade. |
| GET | /$/GetAadMetadata | Gets the Azure Active Directory metadata used for secured connection to cluster. |
| GET | /$/GetClusterVersion | Get the current Service Fabric cluster version. |
| GET | /$/GetLoadInformation | Gets the load of a Service Fabric cluster. |
| POST | /$/ToggleVerboseServicePlacementHealthReporting | Changes the verbosity of service placement health reporting. |
| POST | /$/RecoverSystemPartitions | Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. |
| POST | /$/RecoverAllPartitions | Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss. |
| POST | /$/CreateRepairTask | Creates a new repair task. |
| POST | /$/CancelRepairTask | Requests the cancellation of the given repair task. |
| POST | /$/DeleteRepairTask | Deletes a completed repair task. |
| GET | /$/GetRepairTaskList | Gets a list of repair tasks matching the given filters. |
| POST | /$/ForceApproveRepairTask | Forces the approval of the given repair task. |
| POST | /$/UpdateRepairTaskHealthPolicy | Updates the health policy of the given repair task. |
| POST | /$/UpdateRepairExecutionState | Updates the execution state of a repair task. |
| POST | /$/InvokeInfrastructureCommand | Invokes an administrative command on the given Infrastructure Service instance. |
| GET | /$/InvokeInfrastructureQuery | Invokes a read-only query on the given infrastructure service instance. |

### Nodes
| Method | Path | Description |
|--------|------|-------------|
| GET | /Nodes | Gets the list of nodes in the Service Fabric cluster. |
| GET | /Nodes/{nodeName} | Gets the information about a specific node in the Service Fabric cluster. |
| GET | /Nodes/{nodeName}/$/GetHealth | Gets the health of a Service Fabric node. |
| POST | /Nodes/{nodeName}/$/GetHealth | Gets the health of a Service Fabric node, by using the specified health policy. |
| POST | /Nodes/{nodeName}/$/ReportHealth | Sends a health report on the Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetLoadInformation | Gets the load information of a Service Fabric node. |
| POST | /Nodes/{nodeName}/$/Deactivate | Deactivate a Service Fabric cluster node with the specified deactivation intent. |
| POST | /Nodes/{nodeName}/$/Activate | Activate a Service Fabric cluster node that is currently deactivated. |
| POST | /Nodes/{nodeName}/$/RemoveNodeState | Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. |
| POST | /Nodes/{nodeName}/$/Restart | Restarts a Service Fabric cluster node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes | Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. |
| GET | /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. |
| GET | /Nodes/{nodeName}/$/GetApplications | Gets the list of applications deployed on a Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId} | Gets the information about an application deployed on a Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth | Gets the information about health of an application deployed on a Service Fabric node. |
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth | Gets the information about health of an application deployed on a Service Fabric node. using the specified policy. |
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth | Sends a health report on the Service Fabric application deployed on a Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas | Gets the list of replicas deployed on a Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail | Gets the details of replica deployed on a Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas | Gets the details of replica deployed on a Service Fabric node. |
| POST | /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart | Restarts a service replica of a persisted service running on a node. |
| POST | /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete | Removes a service replica running on a node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages | Gets the list of service packages deployed on a Service Fabric node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName} | Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth | Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application. |
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth | Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy. |
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth | Sends a health report on the Service Fabric deployed service package. |
| POST | /Nodes/{nodeName}/$/DeployServicePackage | Downloads all of the code packages associated with specified service manifest on the specified node. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages | Gets the list of code packages deployed on a Service Fabric node. |
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart | Restarts a code package deployed on a Service Fabric node in a cluster. |
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs | Gets the container logs for container deployed on a Service Fabric node. |
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi | Invoke container API on a container deployed on a Service Fabric node. |

### ApplicationTypes
| Method | Path | Description |
|--------|------|-------------|
| GET | /ApplicationTypes | Gets the list of application types in the Service Fabric cluster. |
| GET | /ApplicationTypes/{applicationTypeName} | Gets the list of application types in the Service Fabric cluster matching exactly the specified name. |
| POST | /ApplicationTypes/$/Provision | Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store. |
| POST | /ApplicationTypes/{applicationTypeName}/$/Unprovision | Removes or unregisters a Service Fabric application type from the cluster. |
| GET | /ApplicationTypes/{applicationTypeName}/$/GetServiceTypes | Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. |
| GET | /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. |
| GET | /ApplicationTypes/{applicationTypeName}/$/GetServiceManifest | Gets the manifest describing a service type. |
| GET | /ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest | Gets the manifest describing an application type. |

### Applications
| Method | Path | Description |
|--------|------|-------------|
| POST | /Applications/$/Create | Creates a Service Fabric application. |
| POST | /Applications/{applicationId}/$/Delete | Deletes an existing Service Fabric application. |
| GET | /Applications/{applicationId}/$/GetLoadInformation | Gets load information about a Service Fabric application. |
| GET | /Applications | Gets the list of applications created in the Service Fabric cluster that match the specified filters. |
| GET | /Applications/{applicationId} | Gets information about a Service Fabric application. |
| GET | /Applications/{applicationId}/$/GetHealth | Gets the health of the service fabric application. |
| POST | /Applications/{applicationId}/$/GetHealth | Gets the health of a Service Fabric application using the specified policy. |
| POST | /Applications/{applicationId}/$/ReportHealth | Sends a health report on the Service Fabric application. |
| POST | /Applications/{applicationId}/$/Upgrade | Starts upgrading an application in the Service Fabric cluster. |
| GET | /Applications/{applicationId}/$/GetUpgradeProgress | Gets details for the latest upgrade performed on this application. |
| POST | /Applications/{applicationId}/$/UpdateUpgrade | Updates an ongoing application upgrade in the Service Fabric cluster. |
| POST | /Applications/{appl

… (truncated)