POST /v2/add-ons/saas
To create an add-on resource, send a POST request to /v2/add-ons/saas with required parameters.
Some add-ons require additional metadata to be provided in the request body. To find out
what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app_slug}/metadata.
Servers
- https://api.digitalocean.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
fleet_uuid |
String | No |
UUID of the fleet/project to which this resource will belong. |
name |
String | Yes |
The name of the addon resource. |
app_slug |
String | Yes |
The slug identifier for the application associated with the resource. |
plan_slug |
String | Yes |
The slug identifier for the plan associated with the resource. |
metadata[] |
Array | Yes |
Metadata associated with the resource, set by the user. Metadata expected varies per app, and can be verified with a GET request to "/v2/add-ons/apps/{app_slug}/metadata" |
metadata[].name |
String | Yes |
The name of the metadata item to be set. |
metadata[].value |
Yes |
The value to be set for the metadata item, which can be a string or boolean. |
|
linked_droplet_id |
Integer | No |
ID of the droplet to be linked to this resource, if applicable. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.