Skip to content

Service Fabric Client APIs API

by azure.com

No authHTTPSCloud Platforms
Open documentation ↗

Overview

Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.

Service Fabric Client APIs is a cloud platforms API from azure.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 234 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Base URL
http://azure.local:19080
Version
6.5.0.36
Endpoints
234
Spec updated
2018-03-10

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "http://azure.local:19080/$/GetAadMetadata" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("http://azure.local:19080/$/GetAadMetadata", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "http://azure.local:19080/$/GetAadMetadata",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/$/CancelRepairTaskRequests the cancellation of the given repair task.
POST/$/CreateRepairTaskCreates a new repair task.
POST/$/DeleteRepairTaskDeletes a completed repair task.
POST/$/ForceApproveRepairTaskForces the approval of the given repair task.
GET/$/GetAadMetadataGets the Azure Active Directory metadata used for secured connection to cluster.
GET/$/GetClusterConfigurationGet the Service Fabric standalone cluster configuration.
GET/$/GetClusterConfigurationUpgradeStatusGet the cluster configuration upgrade status of a Service Fabric standalone cluster.
GET/$/GetClusterHealthGets the health of a Service Fabric cluster.
POST/$/GetClusterHealthGets the health of a Service Fabric cluster using the specified policy.
GET/$/GetClusterHealthChunkGets the health of a Service Fabric cluster using health chunks.
POST/$/GetClusterHealthChunkGets the health of a Service Fabric cluster using health chunks.
GET/$/GetClusterManifestGet the Service Fabric cluster manifest.
GET/$/GetClusterVersionGet the current Service Fabric cluster version.
GET/$/GetLoadInformationGets the load of a Service Fabric cluster.
GET/$/GetProvisionedCodeVersionsGets a list of fabric code versions that are provisioned in a Service Fabric cluster.
GET/$/GetProvisionedConfigVersionsGets a list of fabric config versions that are provisioned in a Service Fabric cluster.
GET/$/GetRepairTaskListGets a list of repair tasks matching the given filters.
GET/$/GetUpgradeOrchestrationServiceStateGet the service state of Service Fabric Upgrade Orchestration Service.
GET/$/GetUpgradeProgressGets the progress of the current cluster upgrade.
POST/$/InvokeInfrastructureCommandInvokes an administrative command on the given Infrastructure Service instance.
GET/$/InvokeInfrastructureQueryInvokes a read-only query on the given infrastructure service instance.
POST/$/MoveToNextUpgradeDomainMake the cluster upgrade move on to the next upgrade domain.
POST/$/ProvisionProvision the code or configuration packages of a Service Fabric cluster.
POST/$/RecoverAllPartitionsIndicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.
POST/$/RecoverSystemPartitionsIndicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.
POST/$/ReportClusterHealthSends a health report on the Service Fabric cluster.
POST/$/RollbackUpgradeRoll back the upgrade of a Service Fabric cluster.
POST/$/SetUpgradeOrchestrationServiceStateUpdate the service state of Service Fabric Upgrade Orchestration Service.
POST/$/StartClusterConfigurationUpgradeStart upgrading the configuration of a Service Fabric standalone cluster.
POST/$/ToggleVerboseServicePlacementHealthReportingChanges the verbosity of service placement health reporting.
POST/$/UnprovisionUnprovision the code or configuration packages of a Service Fabric cluster.
POST/$/UpdateRepairExecutionStateUpdates the execution state of a repair task.
POST/$/UpdateRepairTaskHealthPolicyUpdates the health policy of the given repair task.
POST/$/UpdateUpgradeUpdate the upgrade parameters of a Service Fabric cluster upgrade.
POST/$/UpgradeStart upgrading the code or configuration version of a Service Fabric cluster.
GET/ApplicationTypesGets the list of application types in the Service Fabric cluster.
POST/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
GET/ApplicationTypes/{applicationTypeName}Gets the list of application types in the Service Fabric cluster matching exactly the specified name.
GET/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifestGets the manifest describing an application type.
GET/ApplicationTypes/{applicationTypeName}/$/GetServiceManifestGets the manifest describing a service type.
GET/ApplicationTypes/{applicationTypeName}/$/GetServiceTypesGets 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.
POST/ApplicationTypes/{applicationTypeName}/$/UnprovisionRemoves or unregisters a Service Fabric application type from the cluster.
GET/ApplicationsGets the list of applications created in the Service Fabric cluster that match the specified filters.
POST/Applications/$/CreateCreates a Service Fabric application.
GET/Applications/{applicationId}Gets information about a Service Fabric application.
POST/Applications/{applicationId}/$/DeleteDeletes an existing Service Fabric application.
POST/Applications/{applicationId}/$/DisableBackupDisables periodic backup of Service Fabric application.
POST/Applications/{applicationId}/$/EnableBackupEnables periodic backup of stateful partitions under this Service Fabric application.
GET/Applications/{applicationId}/$/GetBackupConfigurationInfoGets the Service Fabric application backup configuration information.
GET/Applications/{applicationId}/$/GetBackupsGets the list of backups available for every partition in this application.
GET/Applications/{applicationId}/$/GetHealthGets the health of the service fabric application.
POST/Applications/{applicationId}/$/GetHealthGets the health of a Service Fabric application using the specified policy.
GET/Applications/{applicationId}/$/GetLoadInformationGets load information about a Service Fabric application.
GET/Applications/{applicationId}/$/GetServicesGets the information about all services belonging to the application specified by the application ID.
POST/Applications/{applicationId}/$/GetServices/$/CreateCreates the specified Service Fabric service.
POST/Applications/{applicationId}/$/GetServices/$/CreateFromTemplateCreates a Service Fabric service from the service template.
GET/Applications/{applicationId}/$/GetServices/{serviceId}Gets the information about the specific service belonging to the Service Fabric application.
GET/Applications/{applicationId}/$/GetUpgradeProgressGets details for the latest upgrade performed on this application.
POST/Applications/{applicationId}/$/MoveToNextUpgradeDomainResumes upgrading an application in the Service Fabric cluster.
POST/Applications/{applicationId}/$/ReportHealthSends a health report on the Service Fabric application.
POST/Applications/{applicationId}/$/ResumeBackupResumes periodic backup of a Service Fabric application which was previously suspended.
POST/Applications/{applicationId}/$/RollbackUpgradeStarts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.
POST/Applications/{applicationId}/$/SuspendBackupSuspends periodic backup for the specified Service Fabric application.
POST/Applications/{applicationId}/$/UpdateUpgradeUpdates an ongoing application upgrade in the Service Fabric cluster.
POST/Applications/{applicationId}/$/UpgradeStarts upgrading an application in the Service Fabric cluster.
POST/BackupRestore/$/GetBackupsGets the list of backups available for the specified backed up entity at the specified backup location.
GET/BackupRestore/BackupPoliciesGets all the backup policies configured.
POST/BackupRestore/BackupPolicies/$/CreateCreates a backup policy.
GET/BackupRestore/BackupPolicies/{backupPolicyName}Gets a particular backup policy by name.
POST/BackupRestore/BackupPolicies/{backupPolicyName}/$/DeleteDeletes the backup policy.
GET/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntitiesGets the list of backup entities that are associated with this policy.
POST/BackupRestore/BackupPolicies/{backupPolicyName}/$/UpdateUpdates the backup policy.
GET/ComposeDeploymentsGets the list of compose deployments created in the Service Fabric cluster.
PUT/ComposeDeployments/$/CreateCreates a Service Fabric compose deployment.
GET/ComposeDeployments/{deploymentName}Gets information about a Service Fabric compose deployment.
POST/ComposeDeployments/{deploymentName}/$/DeleteDeletes an existing Service Fabric compose deployment from cluster.
GET/ComposeDeployments/{deploymentName}/$/GetUpgradeProgressGets details for the latest upgrade performed on this Service Fabric compose deployment.
POST/ComposeDeployments/{deploymentName}/$/RollbackUpgradeStarts rolling back a compose deployment upgrade in the Service Fabric cluster.
POST/ComposeDeployments/{deploymentName}/$/UpgradeStarts upgrading a compose deployment in the Service Fabric cluster.
GET/EventsStore/Applications/EventsGets all Applications-related events.
GET/EventsStore/Applications/{applicationId}/$/EventsGets an Application-related events.
GET/EventsStore/Cluster/EventsGets all Cluster-related events.
GET/EventsStore/Containers/EventsGets all Containers-related events.
GET/EventsStore/CorrelatedEvents/{eventInstanceId}/$/EventsGets all correlated events for a given event.
GET/EventsStore/Nodes/EventsGets all Nodes-related Events.
GET/EventsStore/Nodes/{nodeName}/$/EventsGets a Node-related events.
GET/EventsStore/Partitions/EventsGets all Partitions-related events.
GET/EventsStore/Partitions/{partitionId}/$/EventsGets a Partition-related events.
GET/EventsStore/Partitions/{partitionId}/$/Replicas/EventsGets all Replicas-related events for a Partition.
GET/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/EventsGets a Partition Replica-related events.
GET/EventsStore/Services/EventsGets all Services-related events.
GET/EventsStore/Services/{serviceId}/$/EventsGets a Service-related events.
GET/Faults/Gets a list of user-induced fault operations filtered by provided input.
POST/Faults/$/CancelCancels a user-induced fault operation.
GET/Faults/Nodes/{nodeName}/$/GetTransitionProgressGets the progress of an operation started using StartNodeTransition.
POST/Faults/Nodes/{nodeName}/$/StartTransition/Starts or stops a cluster node.
GET/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgressGets the progress of a partition data loss operation started using the StartDataLoss API.
GET/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgressGets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.
GET/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgressGets the progress of a PartitionRestart operation started using StartPartitionRestart.

Showing the first 100 of 234 endpoints; the full list is in the documentation.

Questions

Does the Service Fabric Client APIs API need an API key?

No. The Service Fabric Client APIs API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the Service Fabric Client APIs API support HTTPS?

Yes, the Service Fabric Client APIs API is served over HTTPS.

How many endpoints does the Service Fabric Client APIs API have?

Its OpenAPI description lists 234 endpoints in version 6.5.0.36. The first 100 are shown on this page.

What are alternatives to the Service Fabric Client APIs API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).