Overview
# Introduction This API allows resellers to manage their resources in a simple, programmatic way using HTTP requests. # Conventions ## Requests The API supports different methods depending on the required action. | Method | Description | --- | --- | GET | Retrieve resources in a collection or get a single resource.<br/>Getters will never have any effect on the queried resources. | POST | Create a new resource in a collection. | PUT | Update an existing resource with its new representation. | DELETE | Delete an existing resource. ## HTTP status codes The API will reply with different HTTP statuscodes: | StatusCode | Description | --- | --- | 200 OK | The requests was processed and you receive data as a result. | 201 CREATED | The resource has been created. Either the Location header contains a link to the created resource, or links are being returned in the response body. The applied method will be indicated in the documentation. | 202 ACCEPTED | The request has been validated and accepted. Because we need to do some background processing prior to returning the result, we cannot send back a useful representation. | 204 NOCONTENT | The request has been processed, but no details can be returned. | 400 BADREQUEST | Your request is malformed. | 401 UNAUTHORIZED | You are not authorized. Follow the instructions in the Authorization documentation. | 403 FORBIDDEN | Access to the resource or operation is not allowed. | 404 NOTFOUND | The resource cannot be found. | 410 GONE | The resource is permanently no longer available. | 429 TOOMANYREQUESTS | The ratelimit has been exceeded. Please refer to the documentation on rate limiting for more details. | 500 INTERNALSERVERERROR | An error occurred during the processing of the request. The error is unexpected and most likely due to a bug in the api. In the event of a problem, the body of the response will usually contain an errorcode and errormessage. In rare cases additional details about the error are reported. Errorcodes 400-499 are considered to be client errors and indicate that there was an issue with the request. We will not take any action besides monitoring. Errorcodes 500-599 are considered to be server errors. The errors are monitored AND action will be taken to resolve the error. ## Formatting Snake casing is applied on resources and query parameters. The API is strictly returning JSON. No other formats are supported. Datetimes are returned in ISO-8601 format. ## Pagination Pagination is on by default on collections and is controlled by specifying *skip* and *take* parameters. **Skip** indicates the number of results to skip and where to start the new take. **Take** indicates the number of records to return. The returned number of items can be smaller than the requested take. Paged results will have headers with useful information regarding the paging. | Header | Description | --- | --- | X-Paging-Skipped | The number of results that have been skipped. | X-Paging-Take | The number of items in the current take. The number might differ from the requested take. It represents the actual number of items returned in the response. | X-Paging-TotalResults | The total number of results regardless of paging. ## Rate limiting The number of requests per interval is limited. Detailed information on the rate limiting can be found in specific headers which will be sent on each request. | Header | Description | --- | --- | X-RateLimit-Limit | The number of requests that can be made in a specific time interval. | X-RateLimit-Usage | The number of requests already made in the current time interval. | X-RateLimit-Remaining | The number of requests remaining until the reset. | X-RateLimit-Reset | The number of seconds until the reset.<br />After the reset you are allowed to make as many requests as specified by the X-RateLimit-Limit header. | Retry-After | The number of seconds you have to wait until you can make new requests.<br />This header is only present when the rate limit has been reached. I
Public Api is a cloud platforms API from combell.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 75 endpoints.
At a glance
- Authentication
- No auth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- v2
- Endpoints
- 75
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /accounts | Overview of accounts |
| POST | /accounts | Create a new account |
| GET | /accounts/{accountId} | Get a specific account |
| GET | /dns/{domainName}/records | Get records |
| POST | /dns/{domainName}/records | Create a record |
| GET | /dns/{domainName}/records/{recordId} | Get specific record |
| PUT | /dns/{domainName}/records/{recordId} | Edit a record |
| DELETE | /dns/{domainName}/records/{recordId} | Delete a record |
| GET | /domains | Overviews of domains |
| POST | /domains/registrations | Register a domain |
| POST | /domains/transfers | Transfer a domain |
| GET | /domains/{domainName} | Details of a domain |
| PUT | /domains/{domainName}/nameservers | Edit domain name servers |
| PUT | /domains/{domainName}/renew | Edit domain name renew state |
| GET | /linuxhostings | Overview of linux hostings |
| GET | /linuxhostings/{domainName} | Linux hosting detail |
| PUT | /linuxhostings/{domainName}/ftp/configuration | Configure FTP |
| PUT | /linuxhostings/{domainName}/phpsettings/apcu | Configure PHP APCu setting |
| GET | /linuxhostings/{domainName}/phpsettings/availableversions | Get the available PHP versions. |
| PUT | /linuxhostings/{domainName}/phpsettings/memorylimit | Configure PHP memory limit |
| PUT | /linuxhostings/{domainName}/phpsettings/version | Change the Linux hosting PHP version. |
| GET | /linuxhostings/{domainName}/scheduledtasks | Overview of scheduled tasks |
| POST | /linuxhostings/{domainName}/scheduledtasks | Add a scheduled task |
| GET | /linuxhostings/{domainName}/scheduledtasks/{scheduledTaskId} | Get scheduled task detail |
| PUT | /linuxhostings/{domainName}/scheduledtasks/{scheduledTaskId} | Configure a scheduled task |
| DELETE | /linuxhostings/{domainName}/scheduledtasks/{scheduledTaskId} | Delete a scheduled task |
| PUT | /linuxhostings/{domainName}/settings/gzipcompression | Enable/disable GZIP compression |
| POST | /linuxhostings/{domainName}/sites/{siteName}/hostheaders | Create a host header |
| PUT | /linuxhostings/{domainName}/sites/{siteName}/http2/configuration | Configure HTTP/2 |
| PUT | /linuxhostings/{domainName}/ssh/configuration | Configure SSH |
| GET | /linuxhostings/{domainName}/ssh/keys | Overview of SSH keys |
| POST | /linuxhostings/{domainName}/ssh/keys | Add a SSH key |
| DELETE | /linuxhostings/{domainName}/ssh/keys/{fingerprint} | Delete a SSH key |
| PUT | /linuxhostings/{domainName}/sslsettings/{hostname}/autoredirect | Configure auto redirect |
| PUT | /linuxhostings/{domainName}/sslsettings/{hostname}/letsencrypt | Configure let's encrypt |
| POST | /linuxhostings/{domainName}/subsites | Create a subsite |
| DELETE | /linuxhostings/{domainName}/subsites/{siteName} | Delete a subsite |
| GET | /mailboxes | Gets your mailboxes. |
| POST | /mailboxes | Create a new mailbox. |
| GET | /mailboxes/{mailboxName} | Get a specific mailbox |
| DELETE | /mailboxes/{mailboxName} | Delete a mailbox |
| PUT | /mailboxes/{mailboxName}/autoforward | Configure auto-forward for mailbox |
| PUT | /mailboxes/{mailboxName}/autoreply | Configure auto-reply for mailbox |
| PUT | /mailboxes/{mailboxName}/password | Change password for mailbox |
| GET | /mailzones/{domainName} | Get the mail zone. |
| POST | /mailzones/{domainName}/aliases | Create a new alias |
| PUT | /mailzones/{domainName}/aliases/{emailAddress} | Configure a alias |
| DELETE | /mailzones/{domainName}/aliases/{emailAddress} | Delete a alias |
| PUT | /mailzones/{domainName}/antispam | Configure anti-spam for mail zone |
| POST | /mailzones/{domainName}/catchall | Create a catch-all on the mail zone |
| DELETE | /mailzones/{domainName}/catchall/{emailAddress} | Delete a catch-all on the mail zone |
| POST | /mailzones/{domainName}/smtpdomains | Create an extra smtp domain |
| PUT | /mailzones/{domainName}/smtpdomains/{hostname} | Configure an extra smtp domain |
| DELETE | /mailzones/{domainName}/smtpdomains/{hostname} | Delete an extra smtp domain |
| GET | /mysqldatabases | Overview of mysql databases |
| POST | /mysqldatabases | Create a new mysql database |
| GET | /mysqldatabases/{databaseName} | Get a specific database |
| DELETE | /mysqldatabases/{databaseName} | Delete a mysql database |
| GET | /mysqldatabases/{databaseName}/users | Overview of mysql users |
| POST | /mysqldatabases/{databaseName}/users | Create a new mysql user |
| DELETE | /mysqldatabases/{databaseName}/users/{userName} | Delete a mysql user |
| PUT | /mysqldatabases/{databaseName}/users/{userName}/password | Change password for mysql user |
| PUT | /mysqldatabases/{databaseName}/users/{userName}/status | Enable/disable mysql user |
| GET | /provisioningjobs/{jobId} | Detail of a provisioning job |
| GET | /servicepacks | Overview of service packs |
| GET | /ssh | Overview of SSH keys |
| GET | /sslcertificaterequests | Overview of SSL certificate requests |
| POST | /sslcertificaterequests | Add a SSL certificate request |
| GET | /sslcertificaterequests/{id} | Detail of a SSL certificate request |
| PUT | /sslcertificaterequests/{id} | Verify the SSL certificate request domain validations |
| GET | /sslcertificates | Overview of SSL certificates |
| GET | /sslcertificates/{sha1Fingerprint} | Detail of a SSL certificate |
| GET | /sslcertificates/{sha1Fingerprint}/download | Download a SSL certificate |
| GET | /windowshostings | Overview of windows hostings |
| GET | /windowshostings/{domainName} | Windows hosting detail |
Questions
Does the Public Api API need an API key?
No. The Public Api API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.
Does the Public Api API support HTTPS?
Yes, the Public Api API is served over HTTPS.
How many endpoints does the Public Api API have?
Its OpenAPI description lists 75 endpoints in version v2. All of them are shown on this page.
What are alternatives to the Public Api API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
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
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
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).