# Vultr Integration via LowCodeAPI
## Overview
Cloud infrastructure platform offering GPU instances for AI and machine learning workloads with global data centers.
## Base Endpoint
```
https://api.lowcodeapi.com/vultr/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Vultr](https://www.vultr.com)
2. **Get your credentials** from [credential page](https://my.vultr.com/settings/#settingsapi)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
**Auth Type**: TOKEN
## API Categories
- **API Keys** - 4 endpoints
- **Account** - 3 endpoints
- **Applications** - 1 endpoints
- **Backups** - 2 endpoints
- **Bare Metal** - 13 endpoints
- **Billing** - 6 endpoints
- **Block Storage** - 7 endpoints
- **CDN** - 5 endpoints
- **Container Registry** - 8 endpoints
- **DNS** - 10 endpoints
- **Firewall** - 9 endpoints
- **ISO** - 5 endpoints
- **Instances** - 20 endpoints
- **Kubernetes** - 12 endpoints
- **Load Balancers** - 5 endpoints
- **Logs** - 1 endpoints
- **Managed Databases** - 6 endpoints
- **Object Storage** - 7 endpoints
- **Operating Systems** - 1 endpoints
- **Plans** - 2 endpoints
- **Regions** - 2 endpoints
- **Reserved IPs** - 8 endpoints
- **SSH Keys** - 5 endpoints
- **Serverless Inference** - 6 endpoints
- **Snapshots** - 6 endpoints
- **Startup Scripts** - 5 endpoints
- **Storage Gateways** - 6 endpoints
- **Users** - 5 endpoints
- **VFS** - 7 endpoints
- **VPCs** - 8 endpoints
## Common Endpoints
### Category: API Keys
#### List API Keys
**Method**: `GET` | **LowCodeAPI Path**: `/v2/apikeys`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/apikeys?api_token={api_token}
```
**Description**: Gets all API keys for the currently authenticated user. API keys returned by this method are masked
---
#### Get API Key
**Method**: `GET` | **LowCodeAPI Path**: `/v2/apikeys/apikeyid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/apikeys/apikeyid?apikey-id={apikey-id}&api_token={api_token}
```
**Description**: Gets information about an API key for the currently authenticated user. API keys returned by this method are masked
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`apikey-id` | string | Yes | The API Key id |
---
#### Create API Key
**Method**: `POST` | **LowCodeAPI Path**: `/v2/apikeys`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/apikeys?api_token={api_token}
```
**Description**: Adds an API key to the currently authenticated user's API key list
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete API Key
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/apikeys/apikeyid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/apikeys/apikeyid?apikey-id={apikey-id}&api_token={api_token}
```
**Description**: Delete an API key from the currently authenticated user's API key list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`apikey-id` | string | Yes | The API Key id |
---
### Category: Account
#### Get Account Info
**Method**: `GET` | **LowCodeAPI Path**: `/v2/account`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/account?api_token={api_token}
```
**Description**: Get your Vultr account, permission, and billing information
---
#### Get Account BGP Info
**Method**: `GET` | **LowCodeAPI Path**: `/v2/account/bgp`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/account/bgp?api_token={api_token}
```
**Description**: Get your Vultr account BGP information
---
#### Get Account Bandwidth Info
**Method**: `GET` | **LowCodeAPI Path**: `/v2/account/bandwidth`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/account/bandwidth?api_token={api_token}
```
**Description**: Get your Vultr account bandwidth information
---
### Category: Applications
#### List Applications
**Method**: `GET` | **LowCodeAPI Path**: `/v2/applications`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/applications?type={type}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: Get a list of all available Applications
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`type` | string | No | Filter the results by type |
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
### Category: Backups
#### List Backups
**Method**: `GET` | **LowCodeAPI Path**: `/v2/backups`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/backups?instance_id={instance_id}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: Get information about Backups in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance_id` | string | No | Filter the backup list by Instance id |
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Get Backup
**Method**: `GET` | **LowCodeAPI Path**: `/v2/backups/backupid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/backups/backupid?backup-id={backup-id}&api_token={api_token}
```
**Description**: Get the information for the Backup
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`backup-id` | string | Yes | The Backup id |
---
### Category: Bare Metal
#### List Bare Metal Instances
**Method**: `GET` | **LowCodeAPI Path**: `/v2/bare-metals`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals?per_page={per_page}&cursor={cursor}&tag={tag}&label={label}&main_ip={main_ip}&api_token={api_token}
```
**Description**: Get all Bare Metal instances in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
|`tag` | string | No | Filter by specific tag |
|`label` | string | No | Filter by label |
|`main_ip` | string | No | Filter by main IP address |
---
#### Create Bare Metal Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/bare-metals`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals?api_token={api_token}
```
**Description**: Create a new Bare Metal instance
**Request Body**:
```json
{
"plan": "<string>",
"region": "<string>"
}
```
---
#### Get Bare Metal Instance
**Method**: `GET` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Get information about a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Update Bare Metal Instance
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Update a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Bare Metal Instance
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Delete a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Start Bare Metal Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/start`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/start?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Start a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Reboot Bare Metal Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/reboot`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/reboot?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Reboot a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Halt Bare Metal Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/halt`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/halt?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Halt a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Reinstall Bare Metal Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/reinstall`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/reinstall?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Reinstall the operating system on a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List Bare Metal IPv4 Addresses
**Method**: `GET` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/ipv4`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/ipv4?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Get the IPv4 information for a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### List Bare Metal IPv6 Addresses
**Method**: `GET` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/ipv6`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/ipv6?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Get the IPv6 information for a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Get Bare Metal Bandwidth
**Method**: `GET` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/bandwidth`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/bandwidth?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Get bandwidth information for a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
#### Get Bare Metal User Data
**Method**: `GET` | **LowCodeAPI Path**: `/v2/bare-metals/baremetalinstanceid/user-data`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/bare-metals/baremetalinstanceid/user-data?bare-metal-id={bare-metal-id}&api_token={api_token}
```
**Description**: Get the user-supplied, base64 encoded user data for a Bare Metal instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bare-metal-id` | string | Yes | The Bare Metal instance ID |
---
### Category: Billing
#### List Billing History
**Method**: `GET` | **LowCodeAPI Path**: `/v2/billing/history`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/billing/history?api_token={api_token}
```
**Description**: Retrieve list of billing history
---
#### List Invoices
**Method**: `GET` | **LowCodeAPI Path**: `/v2/billing/invoices`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/billing/invoices?api_token={api_token}
```
**Description**: Retrieve a list of invoices
---
#### Get Invoice
**Method**: `GET` | **LowCodeAPI Path**: `/v2/billing/invoices/invoiceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/billing/invoices/invoiceid?invoice-id={invoice-id}&api_token={api_token}
```
**Description**: Retrieve specified invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice-id` | string | Yes | ID of invoice |
---
#### Get Invoice Items
**Method**: `GET` | **LowCodeAPI Path**: `/v2/billing/invoices/invoiceid/items`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/billing/invoices/invoiceid/items?invoice-id={invoice-id}&api_token={api_token}
```
**Description**: Retrieve full specified invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice-id` | string | Yes | ID of invoice |
---
#### List Pending Charges
**Method**: `GET` | **LowCodeAPI Path**: `/v2/billing/pending-charges`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/billing/pending-charges?api_token={api_token}
```
**Description**: Retrieve list of billing pending charges
---
#### Get Pending Charges CSV
**Method**: `GET` | **LowCodeAPI Path**: `/v2/billing/pending-charges/csv`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/billing/pending-charges/csv?api_token={api_token}
```
**Description**: Get pending charges as CSV file. Returns all current month charges
---
### Category: Block Storage
#### List Block Storage
**Method**: `GET` | **LowCodeAPI Path**: `/v2/blocks`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Block Storage in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Block Storage
**Method**: `POST` | **LowCodeAPI Path**: `/v2/blocks`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks?api_token={api_token}
```
**Description**: Create new Block Storage in a region with a size of size_gb. Size may range between 10 and 40000 depending on the block_type
**Request Body**:
```json
{
"region": "<string>",
"size_gb": "<number>"
}
```
---
#### Get Block Storage
**Method**: `GET` | **LowCodeAPI Path**: `/v2/blocks/blockid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks/blockid?block-id={block-id}&api_token={api_token}
```
**Description**: Get information for Block Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`block-id` | string | Yes | The Block Storage id |
---
#### Update Block Storage
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/blocks/blockid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks/blockid?block-id={block-id}&api_token={api_token}
```
**Description**: Update information for Block Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`block-id` | string | Yes | The Block Storage id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Block Storage
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/blocks/blockid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks/blockid?block-id={block-id}&api_token={api_token}
```
**Description**: Delete Block Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`block-id` | string | Yes | The Block Storage id |
---
#### Attach Block Storage
**Method**: `POST` | **LowCodeAPI Path**: `/v2/blocks/blockid/attach`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks/blockid/attach?block-id={block-id}&api_token={api_token}
```
**Description**: Attach Block Storage to Instance instance_id
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`block-id` | string | Yes | The Block Storage id |
**Request Body**:
```json
{
"instance_id": "<string>"
}
```
---
#### Detach Block Storage
**Method**: `POST` | **LowCodeAPI Path**: `/v2/blocks/blockid/detach`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/blocks/blockid/detach?block-id={block-id}&api_token={api_token}
```
**Description**: Detach Block Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`block-id` | string | Yes | The Block Storage id |
**Request Body**:
```json
{
"key": "value"
}
```
---
### Category: CDN
#### List CDN Endpoints
**Method**: `GET` | **LowCodeAPI Path**: `/v2/cdn`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/cdn?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all CDN endpoints in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create CDN Endpoint
**Method**: `POST` | **LowCodeAPI Path**: `/v2/cdn`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/cdn?api_token={api_token}
```
**Description**: Create a new CDN endpoint
**Request Body**:
```json
{
"origin": "<string>"
}
```
---
#### Get CDN Endpoint
**Method**: `GET` | **LowCodeAPI Path**: `/v2/cdn/cdnid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/cdn/cdnid?cdn-id={cdn-id}&api_token={api_token}
```
**Description**: Get information about a CDN endpoint
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`cdn-id` | string | Yes | The CDN endpoint ID |
---
#### Update CDN Endpoint
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/cdn/cdnid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/cdn/cdnid?cdn-id={cdn-id}&api_token={api_token}
```
**Description**: Update a CDN endpoint
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`cdn-id` | string | Yes | The CDN endpoint ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete CDN Endpoint
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/cdn/cdnid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/cdn/cdnid?cdn-id={cdn-id}&api_token={api_token}
```
**Description**: Delete a CDN endpoint
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`cdn-id` | string | Yes | The CDN endpoint ID |
---
### Category: Container Registry
#### List Container Registries
**Method**: `GET` | **LowCodeAPI Path**: `/v2/container-registry`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Container Registries in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Container Registry
**Method**: `POST` | **LowCodeAPI Path**: `/v2/container-registry`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry?api_token={api_token}
```
**Description**: Create a new Container Registry
**Request Body**:
```json
{
"name": "<string>"
}
```
---
#### Get Container Registry
**Method**: `GET` | **LowCodeAPI Path**: `/v2/container-registry/registryid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry/registryid?registry-id={registry-id}&api_token={api_token}
```
**Description**: Get information about a Container Registry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`registry-id` | string | Yes | The Container Registry ID |
---
#### Update Container Registry
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/container-registry/registryid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry/registryid?registry-id={registry-id}&api_token={api_token}
```
**Description**: Update a Container Registry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`registry-id` | string | Yes | The Container Registry ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Container Registry
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/container-registry/registryid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry/registryid?registry-id={registry-id}&api_token={api_token}
```
**Description**: Delete a Container Registry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`registry-id` | string | Yes | The Container Registry ID |
---
#### List Container Registry Repositories
**Method**: `GET` | **LowCodeAPI Path**: `/v2/container-registry/registryid/repositories`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry/registryid/repositories?registry-id={registry-id}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all repositories in a Container Registry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`registry-id` | string | Yes | The Container Registry ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Get Container Registry Repository
**Method**: `GET` | **LowCodeAPI Path**: `/v2/container-registry/registryid/repositories/repositoryid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry/registryid/repositories/repositoryid?registry-id={registry-id}&repository-name={repository-name}&api_token={api_token}
```
**Description**: Get information about a Container Registry repository
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`registry-id` | string | Yes | The Container Registry ID |
|`repository-name` | string | Yes | The Repository name |
---
#### List Container Registry Artifacts
**Method**: `GET` | **LowCodeAPI Path**: `/v2/container-registry/registryid/repositories/repositoryid/artifacts`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/container-registry/registryid/repositories/repositoryid/artifacts?registry-id={registry-id}&repository-name={repository-name}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all artifacts in a Container Registry repository
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`registry-id` | string | Yes | The Container Registry ID |
|`repository-name` | string | Yes | The Repository name |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
### Category: DNS
#### List DNS Domains
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all DNS Domains in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create DNS Domain
**Method**: `POST` | **LowCodeAPI Path**: `/v2/domains`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains?api_token={api_token}
```
**Description**: Create a DNS Domain for domain. If no ip address is supplied a domain with no records will be created
**Request Body**:
```json
{
"domain": "<string>"
}
```
---
#### Get DNS Domain
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains/dnsdomain`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain?dns-domain={dns-domain}&api_token={api_token}
```
**Description**: Get information for the DNS Domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
---
#### Update DNS Domain
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/domains/dnsdomain`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain?dns-domain={dns-domain}&api_token={api_token}
```
**Description**: Update the DNS Domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
**Request Body**:
```json
{
"dns_sec": "<string>"
}
```
---
#### Delete Domain
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/domains/dnsdomain`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain?dns-domain={dns-domain}&api_token={api_token}
```
**Description**: Delete the DNS Domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
---
#### List DNS Records
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains/dnsdomain/records`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain/records?dns-domain={dns-domain}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: Get the DNS records for the Domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create DNS Record
**Method**: `POST` | **LowCodeAPI Path**: `/v2/domains/dnsdomain/records`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain/records?dns-domain={dns-domain}&api_token={api_token}
```
**Description**: Create a DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
**Request Body**:
```json
{
"name": "<string>",
"type": "<string>",
"data": "<string>"
}
```
---
#### Get DNS Record
**Method**: `GET` | **LowCodeAPI Path**: `/v2/domains/dnsdomain/records/recordid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain/records/recordid?dns-domain={dns-domain}&record-id={record-id}&api_token={api_token}
```
**Description**: Get information for a DNS Record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
|`record-id` | string | Yes | The DNS Record id |
---
#### Update DNS Record
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/domains/dnsdomain/records/recordid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain/records/recordid?dns-domain={dns-domain}&record-id={record-id}&api_token={api_token}
```
**Description**: Update the information for a DNS record. All attributes are optional. If not set, the attributes will retain their original values
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
|`record-id` | string | Yes | The DNS Record id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete DNS Record
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/domains/dnsdomain/records/recordid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/domains/dnsdomain/records/recordid?dns-domain={dns-domain}&record-id={record-id}&api_token={api_token}
```
**Description**: Delete the DNS record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dns-domain` | string | Yes | The DNS Domain |
|`record-id` | string | Yes | The DNS Record id |
---
### Category: Firewall
#### List Firewall Groups
**Method**: `GET` | **LowCodeAPI Path**: `/v2/firewalls`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: Get a list of all Firewall Groups
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Firewall Group
**Method**: `POST` | **LowCodeAPI Path**: `/v2/firewalls`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls?api_token={api_token}
```
**Description**: Create a new Firewall Group
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get Firewall Group
**Method**: `GET` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid?firewall-group-id={firewall-group-id}&api_token={api_token}
```
**Description**: Get information for a Firewall Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
---
#### Update Firewall Group
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid?firewall-group-id={firewall-group-id}&api_token={api_token}
```
**Description**: Update information for a Firewall Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
**Request Body**:
```json
{
"description": "<string>"
}
```
---
#### Delete Firewall Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid?firewall-group-id={firewall-group-id}&api_token={api_token}
```
**Description**: Delete a Firewall Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
---
#### List Firewall Rules
**Method**: `GET` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid/rules`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid/rules?firewall-group-id={firewall-group-id}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: Get the Firewall Rules for a Firewall Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Firewall Rule
**Method**: `POST` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid/rules`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid/rules?firewall-group-id={firewall-group-id}&api_token={api_token}
```
**Description**: Create a Firewall Rule for a Firewall Group. The attributes ip_type, protocol, subnet, and subnet_size are required
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
**Request Body**:
```json
{
"ip_type": "<string>",
"protocol": "<string>",
"subnet": "<string>",
"subnet_size": "<number>"
}
```
---
#### Get Firewall Rule
**Method**: `GET` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid/rules/firewallruleid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid/rules/firewallruleid?firewall-group-id={firewall-group-id}&firewall-rule-id={firewall-rule-id}&api_token={api_token}
```
**Description**: Get a Firewall Rule
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
|`firewall-rule-id` | string | Yes | The Firewall Rule id |
---
#### Delete Firewall Rule
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/firewalls/firewallgroupid/rules/firewallruleid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/firewalls/firewallgroupid/rules/firewallruleid?firewall-group-id={firewall-group-id}&firewall-rule-id={firewall-rule-id}&api_token={api_token}
```
**Description**: Delete a Firewall Rule
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`firewall-group-id` | string | Yes | The Firewall Group id |
|`firewall-rule-id` | string | Yes | The Firewall Rule id |
---
### Category: ISO
#### List ISOs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/iso`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/iso?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all ISOs in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create ISO
**Method**: `POST` | **LowCodeAPI Path**: `/v2/iso`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/iso?api_token={api_token}
```
**Description**: Create a new ISO from a URL
**Request Body**:
```json
{
"url": "<string>"
}
```
---
#### Get ISO
**Method**: `GET` | **LowCodeAPI Path**: `/v2/iso/isoid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/iso/isoid?iso-id={iso-id}&api_token={api_token}
```
**Description**: Get information about an ISO
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`iso-id` | string | Yes | The ISO ID |
---
#### Delete ISO
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/iso/isoid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/iso/isoid?iso-id={iso-id}&api_token={api_token}
```
**Description**: Delete an ISO
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`iso-id` | string | Yes | The ISO ID |
---
#### List Public ISOs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/iso/list-public`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/iso/list-public?api_token={api_token}
```
**Description**: List all public ISOs
---
### Category: Instances
#### List Instances
**Method**: `GET` | **LowCodeAPI Path**: `/v2/instances`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances?per_page={per_page}&cursor={cursor}&tag={tag}&label={label}&main_ip={main_ip}®ion={region}&firewall_group_id={firewall_group_id}&hostname={hostname}&show_pending_charges={show_pending_charges}&api_token={api_token}
```
**Description**: List all VPS instances in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
|`tag` | string | No | Deprecated. Filter by specific tag |
|`label` | string | No | Filter by label |
|`main_ip` | string | No | Filter by main ip address |
|`region` | string | No | Filter by Region id |
|`firewall_group_id` | string | No | Filter by Firewall group id |
|`hostname` | string | No | Filter by hostname |
|`show_pending_charges` | boolean | No | Set to true to show pending charges |
---
#### Create Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances?api_token={api_token}
```
**Description**: Create a new VPS Instance in a region with the desired plan. Choose one of the following to deploy the instance: os_id, iso_id, snapshot_id, app_id, image_id
**Request Body**:
```json
{
"region": "<string>",
"plan": "<string>"
}
```
---
#### Get Instance
**Method**: `GET` | **LowCodeAPI Path**: `/v2/instances/instanceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid?instance-id={instance-id}&api_token={api_token}
```
**Description**: Get information about an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
---
#### Update Instance
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/instances/instanceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid?instance-id={instance-id}&api_token={api_token}
```
**Description**: Update information for an Instance. All attributes are optional. If not set, the attributes will retain their original values
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Instance
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/instances/instanceid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid?instance-id={instance-id}&api_token={api_token}
```
**Description**: Delete an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
---
#### Start Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances/instanceid/start`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/start?instance-id={instance-id}&api_token={api_token}
```
**Description**: Start an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
---
#### Reboot Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances/instanceid/reboot`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/reboot?instance-id={instance-id}&api_token={api_token}
```
**Description**: Reboot an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
---
#### Halt Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances/instanceid/halt`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/halt?instance-id={instance-id}&api_token={api_token}
```
**Description**: Halt an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
---
#### Reinstall Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances/instanceid/reinstall`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/reinstall?instance-id={instance-id}&api_token={api_token}
```
**Description**: Reinstall an Instance using an optional hostname
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get Instance Bandwidth
**Method**: `GET` | **LowCodeAPI Path**: `/v2/instances/instanceid/bandwidth`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/bandwidth?instance-id={instance-id}&date_range={date_range}&api_token={api_token}
```
**Description**: Get bandwidth information about an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`date_range` | number | No | The range of days to include, represented as the number of days relative to the current date. Default 30, Minimum 1 and Max 180 |
---
#### List Instance IPv4 Information
**Method**: `GET` | **LowCodeAPI Path**: `/v2/instances/instanceid/ipv4`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/ipv4?instance-id={instance-id}&public_network={public_network}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List the IPv4 information for an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`public_network` | boolean | No | If true, includes information about the public network adapter (such as MAC address) with the main_ip entry |
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create IPv4
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances/instanceid/ipv4`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/ipv4?instance-id={instance-id}&api_token={api_token}
```
**Description**: Create an IPv4 address for an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get Instance IPv6 Information
**Method**: `GET` | **LowCodeAPI Path**: `/v2/instances/instanceid/ipv6`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/ipv6?instance-id={instance-id}&api_token={api_token}
```
**Description**: Get the IPv6 information for an VPS Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
---
#### List Instance VPCs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/instances/instanceid/vpcs`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/vpcs?instance-id={instance-id}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List the VPCs for an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Attach VPC to Instance
**Method**: `POST` | **LowCodeAPI Path**: `/v2/instances/instanceid/vpcs/attach`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/instances/instanceid/vpcs/attach?instance-id={instance-id}&api_token={api_token}
```
**Description**: Attach a VPC to an Instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`instance-id` | string | Yes | The Instance ID |
**Request Body**:
```json
{
"vpc_id": "<string>"
}
```
---
*Note: Showing 15 of 20 endpoints in this category.*
---
### Category: Kubernetes
#### List Kubernetes Clusters
**Method**: `GET` | **LowCodeAPI Path**: `/v2/kubernetes/clusters`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Kubernetes clusters in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Kubernetes Cluster
**Method**: `POST` | **LowCodeAPI Path**: `/v2/kubernetes/clusters`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters?api_token={api_token}
```
**Description**: Create a new Kubernetes cluster
**Request Body**:
```json
{
"label": "<string>",
"region": "<string>",
"node_pools": "<array>"
}
```
---
#### Get Kubernetes Cluster
**Method**: `GET` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid?vke-id={vke-id}&api_token={api_token}
```
**Description**: Get information about a Kubernetes cluster
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
---
#### Update Kubernetes Cluster
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid?vke-id={vke-id}&api_token={api_token}
```
**Description**: Update a Kubernetes cluster
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Kubernetes Cluster
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid?vke-id={vke-id}&api_token={api_token}
```
**Description**: Delete a Kubernetes cluster
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
---
#### Get Kubernetes Cluster Config
**Method**: `GET` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid/config`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid/config?vke-id={vke-id}&api_token={api_token}
```
**Description**: Get the kubeconfig for a Kubernetes cluster
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
---
#### List Kubernetes Node Pools
**Method**: `GET` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid/node-pools`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid/node-pools?vke-id={vke-id}&api_token={api_token}
```
**Description**: List all node pools for a Kubernetes cluster
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
---
#### Create Kubernetes Node Pool
**Method**: `POST` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid/node-pools`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid/node-pools?vke-id={vke-id}&api_token={api_token}
```
**Description**: Create a new node pool for a Kubernetes cluster
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
**Request Body**:
```json
{
"node_quantity": "<number>",
"plan": "<string>"
}
```
---
#### Get Kubernetes Node Pool
**Method**: `GET` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid/node-pools/nodepoolid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid/node-pools/nodepoolid?vke-id={vke-id}&node-pool-id={node-pool-id}&api_token={api_token}
```
**Description**: Get information about a Kubernetes node pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
|`node-pool-id` | string | Yes | The Node Pool ID |
---
#### Update Kubernetes Node Pool
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid/node-pools/nodepoolid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid/node-pools/nodepoolid?vke-id={vke-id}&node-pool-id={node-pool-id}&api_token={api_token}
```
**Description**: Update a Kubernetes node pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
|`node-pool-id` | string | Yes | The Node Pool ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Kubernetes Node Pool
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/kubernetes/clusters/clusterid/node-pools/nodepoolid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/clusters/clusterid/node-pools/nodepoolid?vke-id={vke-id}&node-pool-id={node-pool-id}&api_token={api_token}
```
**Description**: Delete a Kubernetes node pool
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vke-id` | string | Yes | The Kubernetes cluster ID |
|`node-pool-id` | string | Yes | The Node Pool ID |
---
#### List Kubernetes Versions
**Method**: `GET` | **LowCodeAPI Path**: `/v2/kubernetes/versions`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/kubernetes/versions?api_token={api_token}
```
**Description**: List all available Kubernetes versions
---
### Category: Load Balancers
#### List Load Balancers
**Method**: `GET` | **LowCodeAPI Path**: `/v2/load-balancers`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/load-balancers?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Load Balancers in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Load Balancer
**Method**: `POST` | **LowCodeAPI Path**: `/v2/load-balancers`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/load-balancers?api_token={api_token}
```
**Description**: Create a new Load Balancer
**Request Body**:
```json
{
"region": "<string>",
"forwarding_rules": "<array>"
}
```
---
#### Get Load Balancer
**Method**: `GET` | **LowCodeAPI Path**: `/v2/load-balancers/loadbalancerid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/load-balancers/loadbalancerid?load-balancer-id={load-balancer-id}&api_token={api_token}
```
**Description**: Get information about a Load Balancer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`load-balancer-id` | string | Yes | The Load Balancer ID |
---
#### Update Load Balancer
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/load-balancers/loadbalancerid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/load-balancers/loadbalancerid?load-balancer-id={load-balancer-id}&api_token={api_token}
```
**Description**: Update a Load Balancer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`load-balancer-id` | string | Yes | The Load Balancer ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Load Balancer
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/load-balancers/loadbalancerid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/load-balancers/loadbalancerid?load-balancer-id={load-balancer-id}&api_token={api_token}
```
**Description**: Delete a Load Balancer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`load-balancer-id` | string | Yes | The Load Balancer ID |
---
### Category: Logs
#### List Logs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/logs`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/logs?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all logs in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
### Category: Managed Databases
#### List Managed Databases
**Method**: `GET` | **LowCodeAPI Path**: `/v2/databases`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/databases?per_page={per_page}&cursor={cursor}&tag={tag}&label={label}&api_token={api_token}
```
**Description**: List all Managed Databases in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
|`tag` | string | No | Filter by tag |
|`label` | string | No | Filter by label |
---
#### Create Managed Database
**Method**: `POST` | **LowCodeAPI Path**: `/v2/databases`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/databases?api_token={api_token}
```
**Description**: Create a new Managed Database
**Request Body**:
```json
{
"plan": "<string>",
"region": "<string>",
"database_engine": "<string>"
}
```
---
#### Get Managed Database
**Method**: `GET` | **LowCodeAPI Path**: `/v2/databases/databaseid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/databases/databaseid?database-id={database-id}&api_token={api_token}
```
**Description**: Get information about a Managed Database
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`database-id` | string | Yes | The Database ID |
---
#### Update Managed Database
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/databases/databaseid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/databases/databaseid?database-id={database-id}&api_token={api_token}
```
**Description**: Update a Managed Database
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`database-id` | string | Yes | The Database ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Managed Database
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/databases/databaseid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/databases/databaseid?database-id={database-id}&api_token={api_token}
```
**Description**: Delete a Managed Database
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`database-id` | string | Yes | The Database ID |
---
#### List Managed Database Plans
**Method**: `GET` | **LowCodeAPI Path**: `/v2/databases/plans`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/databases/plans?database_engine={database_engine}&plan_type={plan_type}&api_token={api_token}
```
**Description**: List all available Managed Database plans
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`database_engine` | string | No | Filter by database engine |
|`plan_type` | string | No | Filter by plan type |
---
### Category: Object Storage
#### List Object Storage
**Method**: `GET` | **LowCodeAPI Path**: `/v2/object-storage`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Object Storage clusters in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Object Storage
**Method**: `POST` | **LowCodeAPI Path**: `/v2/object-storage`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage?api_token={api_token}
```
**Description**: Create a new Object Storage
**Request Body**:
```json
{
"cluster_id": "<number>"
}
```
---
#### Get Object Storage
**Method**: `GET` | **LowCodeAPI Path**: `/v2/object-storage/objectstorageid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage/objectstorageid?object-storage-id={object-storage-id}&api_token={api_token}
```
**Description**: Get information about an Object Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`object-storage-id` | string | Yes | The Object Storage ID |
---
#### Update Object Storage
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/object-storage/objectstorageid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage/objectstorageid?object-storage-id={object-storage-id}&api_token={api_token}
```
**Description**: Update an Object Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`object-storage-id` | string | Yes | The Object Storage ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Object Storage
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/object-storage/objectstorageid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage/objectstorageid?object-storage-id={object-storage-id}&api_token={api_token}
```
**Description**: Delete an Object Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`object-storage-id` | string | Yes | The Object Storage ID |
---
#### Regenerate Object Storage Keys
**Method**: `POST` | **LowCodeAPI Path**: `/v2/object-storage/objectstorageid/regenerate-keys`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage/objectstorageid/regenerate-keys?object-storage-id={object-storage-id}&api_token={api_token}
```
**Description**: Regenerate the access keys for an Object Storage
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`object-storage-id` | string | Yes | The Object Storage ID |
---
#### List Object Storage Clusters
**Method**: `GET` | **LowCodeAPI Path**: `/v2/object-storage/clusters`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/object-storage/clusters?api_token={api_token}
```
**Description**: List all Object Storage clusters
---
### Category: Operating Systems
#### List Operating Systems
**Method**: `GET` | **LowCodeAPI Path**: `/v2/os`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/os?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all available operating systems
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
### Category: Plans
#### List Plans
**Method**: `GET` | **LowCodeAPI Path**: `/v2/plans`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/plans?type={type}&os={os}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all available plans
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`type` | string | No | Filter the results by type |
|`os` | string | No | Filter the results by operating system |
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### List Bare Metal Plans
**Method**: `GET` | **LowCodeAPI Path**: `/v2/plans-metal`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/plans-metal?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all available Bare Metal plans
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
### Category: Regions
#### List Regions
**Method**: `GET` | **LowCodeAPI Path**: `/v2/regions`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/regions?api_token={api_token}
```
**Description**: List all available regions
---
#### List Available Plans in Region
**Method**: `GET` | **LowCodeAPI Path**: `/v2/regions/regionid/availability`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/regions/regionid/availability?region-id={region-id}&type={type}&api_token={api_token}
```
**Description**: Get a list of the available plans in a specific region
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`region-id` | string | Yes | The Region ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`type` | string | No | Filter the results by type |
---
### Category: Reserved IPs
#### List Reserved IPs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/reserved-ips`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Reserved IPs in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Reserved IP
**Method**: `POST` | **LowCodeAPI Path**: `/v2/reserved-ips`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips?api_token={api_token}
```
**Description**: Create a new Reserved IP
**Request Body**:
```json
{
"region": "<string>",
"ip_type": "<string>"
}
```
---
#### Get Reserved IP
**Method**: `GET` | **LowCodeAPI Path**: `/v2/reserved-ips/reservedipid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips/reservedipid?reserved-ip={reserved-ip}&api_token={api_token}
```
**Description**: Get information about a Reserved IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`reserved-ip` | string | Yes | The Reserved IP address |
---
#### Update Reserved IP
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/reserved-ips/reservedipid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips/reservedipid?reserved-ip={reserved-ip}&api_token={api_token}
```
**Description**: Update a Reserved IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`reserved-ip` | string | Yes | The Reserved IP address |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Reserved IP
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/reserved-ips/reservedipid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips/reservedipid?reserved-ip={reserved-ip}&api_token={api_token}
```
**Description**: Delete a Reserved IP
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`reserved-ip` | string | Yes | The Reserved IP address |
---
#### Attach Reserved IP
**Method**: `POST` | **LowCodeAPI Path**: `/v2/reserved-ips/reservedipid/attach`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips/reservedipid/attach?reserved-ip={reserved-ip}&api_token={api_token}
```
**Description**: Attach a Reserved IP to an instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`reserved-ip` | string | Yes | The Reserved IP address |
**Request Body**:
```json
{
"instance_id": "<string>"
}
```
---
#### Detach Reserved IP
**Method**: `POST` | **LowCodeAPI Path**: `/v2/reserved-ips/reservedipid/detach`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips/reservedipid/detach?reserved-ip={reserved-ip}&api_token={api_token}
```
**Description**: Detach a Reserved IP from an instance
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`reserved-ip` | string | Yes | The Reserved IP address |
---
#### Convert Instance IP to Reserved IP
**Method**: `POST` | **LowCodeAPI Path**: `/v2/reserved-ips/convert`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/reserved-ips/convert?api_token={api_token}
```
**Description**: Convert an instance IP to a Reserved IP
**Request Body**:
```json
{
"ip_address": "<string>"
}
```
---
### Category: SSH Keys
#### List SSH Keys
**Method**: `GET` | **LowCodeAPI Path**: `/v2/ssh-keys`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/ssh-keys?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all SSH Keys in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create SSH Key
**Method**: `POST` | **LowCodeAPI Path**: `/v2/ssh-keys`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/ssh-keys?api_token={api_token}
```
**Description**: Create a new SSH key
**Request Body**:
```json
{
"name": "<string>",
"ssh_key": "<string>"
}
```
---
#### Get SSH Key
**Method**: `GET` | **LowCodeAPI Path**: `/v2/ssh-keys/sshkeyid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/ssh-keys/sshkeyid?ssh-key-id={ssh-key-id}&api_token={api_token}
```
**Description**: Get information about an SSH key
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ssh-key-id` | string | Yes | The SSH Key ID |
---
#### Update SSH Key
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/ssh-keys/sshkeyid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/ssh-keys/sshkeyid?ssh-key-id={ssh-key-id}&api_token={api_token}
```
**Description**: Update an SSH key
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ssh-key-id` | string | Yes | The SSH Key ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete SSH Key
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/ssh-keys/sshkeyid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/ssh-keys/sshkeyid?ssh-key-id={ssh-key-id}&api_token={api_token}
```
**Description**: Delete an SSH key
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ssh-key-id` | string | Yes | The SSH Key ID |
---
### Category: Serverless Inference
#### List Serverless Functions
**Method**: `GET` | **LowCodeAPI Path**: `/v2/serverless/functions`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/serverless/functions?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Serverless Functions in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Serverless Function
**Method**: `POST` | **LowCodeAPI Path**: `/v2/serverless/functions`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/serverless/functions?api_token={api_token}
```
**Description**: Create a new Serverless Function
**Request Body**:
```json
{
"name": "<string>",
"runtime": "<string>"
}
```
---
#### Get Serverless Function
**Method**: `GET` | **LowCodeAPI Path**: `/v2/serverless/functions/functionid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/serverless/functions/functionid?function-id={function-id}&api_token={api_token}
```
**Description**: Get information about a Serverless Function
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`function-id` | string | Yes | The Function ID |
---
#### Update Serverless Function
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/serverless/functions/functionid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/serverless/functions/functionid?function-id={function-id}&api_token={api_token}
```
**Description**: Update a Serverless Function
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`function-id` | string | Yes | The Function ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Serverless Function
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/serverless/functions/functionid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/serverless/functions/functionid?function-id={function-id}&api_token={api_token}
```
**Description**: Delete a Serverless Function
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`function-id` | string | Yes | The Function ID |
---
#### Get Serverless Function Usage
**Method**: `GET` | **LowCodeAPI Path**: `/v2/serverless/functions/functionid/usage`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/serverless/functions/functionid/usage?function-id={function-id}&api_token={api_token}
```
**Description**: Get usage information for a Serverless Function
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`function-id` | string | Yes | The Function ID |
---
### Category: Snapshots
#### List Snapshots
**Method**: `GET` | **LowCodeAPI Path**: `/v2/snapshots`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/snapshots?per_page={per_page}&cursor={cursor}&description={description}&api_token={api_token}
```
**Description**: Get all snapshots in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
|`description` | string | No | Filter by description |
---
#### Create Snapshot
**Method**: `POST` | **LowCodeAPI Path**: `/v2/snapshots`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/snapshots?api_token={api_token}
```
**Description**: Create a snapshot from an existing instance
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get Snapshot
**Method**: `GET` | **LowCodeAPI Path**: `/v2/snapshots/snapshotid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/snapshots/snapshotid?snapshot-id={snapshot-id}&api_token={api_token}
```
**Description**: Get information about a snapshot
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`snapshot-id` | string | Yes | The Snapshot ID |
---
#### Update Snapshot
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/snapshots/snapshotid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/snapshots/snapshotid?snapshot-id={snapshot-id}&api_token={api_token}
```
**Description**: Update a snapshot
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`snapshot-id` | string | Yes | The Snapshot ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Snapshot
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/snapshots/snapshotid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/snapshots/snapshotid?snapshot-id={snapshot-id}&api_token={api_token}
```
**Description**: Delete a snapshot
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`snapshot-id` | string | Yes | The Snapshot ID |
---
#### Create Snapshot from URL
**Method**: `POST` | **LowCodeAPI Path**: `/v2/snapshots/create-from-url`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/snapshots/create-from-url?api_token={api_token}
```
**Description**: Create a snapshot from a URL
**Request Body**:
```json
{
"url": "<string>"
}
```
---
### Category: Startup Scripts
#### List Startup Scripts
**Method**: `GET` | **LowCodeAPI Path**: `/v2/startup-scripts`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/startup-scripts?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all startup scripts in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Startup Script
**Method**: `POST` | **LowCodeAPI Path**: `/v2/startup-scripts`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/startup-scripts?api_token={api_token}
```
**Description**: Create a new startup script
**Request Body**:
```json
{
"name": "<string>",
"type": "<string>",
"script": "<string>"
}
```
---
#### Get Startup Script
**Method**: `GET` | **LowCodeAPI Path**: `/v2/startup-scripts/startupscriptid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/startup-scripts/startupscriptid?startup-script-id={startup-script-id}&api_token={api_token}
```
**Description**: Get information about a startup script
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`startup-script-id` | string | Yes | The Startup Script ID |
---
#### Update Startup Script
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/startup-scripts/startupscriptid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/startup-scripts/startupscriptid?startup-script-id={startup-script-id}&api_token={api_token}
```
**Description**: Update a startup script
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`startup-script-id` | string | Yes | The Startup Script ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Startup Script
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/startup-scripts/startupscriptid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/startup-scripts/startupscriptid?startup-script-id={startup-script-id}&api_token={api_token}
```
**Description**: Delete a startup script
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`startup-script-id` | string | Yes | The Startup Script ID |
---
### Category: Storage Gateways
#### List Storage Gateways
**Method**: `GET` | **LowCodeAPI Path**: `/v2/storage-gateways`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/storage-gateways?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all Storage Gateways in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create Storage Gateway
**Method**: `POST` | **LowCodeAPI Path**: `/v2/storage-gateways`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/storage-gateways?api_token={api_token}
```
**Description**: Create a new Storage Gateway
**Request Body**:
```json
{
"region": "<string>",
"plan": "<string>"
}
```
---
#### Get Storage Gateway
**Method**: `GET` | **LowCodeAPI Path**: `/v2/storage-gateways/gatewayid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/storage-gateways/gatewayid?gateway-id={gateway-id}&api_token={api_token}
```
**Description**: Get information about a Storage Gateway
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`gateway-id` | string | Yes | The Storage Gateway ID |
---
#### Update Storage Gateway
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/storage-gateways/gatewayid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/storage-gateways/gatewayid?gateway-id={gateway-id}&api_token={api_token}
```
**Description**: Update a Storage Gateway
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`gateway-id` | string | Yes | The Storage Gateway ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete Storage Gateway
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/storage-gateways/gatewayid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/storage-gateways/gatewayid?gateway-id={gateway-id}&api_token={api_token}
```
**Description**: Delete a Storage Gateway
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`gateway-id` | string | Yes | The Storage Gateway ID |
---
#### List Storage Gateway Exports
**Method**: `GET` | **LowCodeAPI Path**: `/v2/storage-gateways/gatewayid/exports`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/storage-gateways/gatewayid/exports?gateway-id={gateway-id}&api_token={api_token}
```
**Description**: List all exports for a Storage Gateway
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`gateway-id` | string | Yes | The Storage Gateway ID |
---
### Category: Users
#### List Users
**Method**: `GET` | **LowCodeAPI Path**: `/v2/users`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/users?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all users in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create User
**Method**: `POST` | **LowCodeAPI Path**: `/v2/users`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/users?api_token={api_token}
```
**Description**: Create a new user
**Request Body**:
```json
{
"email": "<string>",
"name": "<string>",
"password": "<string>"
}
```
---
#### Get User
**Method**: `GET` | **LowCodeAPI Path**: `/v2/users/userid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/users/userid?user-id={user-id}&api_token={api_token}
```
**Description**: Get information about a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user-id` | string | Yes | The User ID |
---
#### Update User
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/users/userid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/users/userid?user-id={user-id}&api_token={api_token}
```
**Description**: Update a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user-id` | string | Yes | The User ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete User
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/users/userid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/users/userid?user-id={user-id}&api_token={api_token}
```
**Description**: Delete a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user-id` | string | Yes | The User ID |
---
### Category: VFS
#### List VFS Regions
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vfs/regions`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs/regions?api_token={api_token}
```
**Description**: List all available VFS regions
---
#### List VFS
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vfs`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all VFS in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create VFS
**Method**: `POST` | **LowCodeAPI Path**: `/v2/vfs`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs?api_token={api_token}
```
**Description**: Create a new VFS
**Request Body**:
```json
{
"region": "<string>",
"size_gb": "<number>"
}
```
---
#### Get VFS
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vfs/vfsid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs/vfsid?vfs-id={vfs-id}&api_token={api_token}
```
**Description**: Get information about a VFS
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vfs-id` | string | Yes | The VFS ID |
---
#### Update VFS
**Method**: `PATCH` | **LowCodeAPI Path**: `/v2/vfs/vfsid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs/vfsid?vfs-id={vfs-id}&api_token={api_token}
```
**Description**: Update a VFS
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vfs-id` | string | Yes | The VFS ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete VFS
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/vfs/vfsid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs/vfsid?vfs-id={vfs-id}&api_token={api_token}
```
**Description**: Delete a VFS
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vfs-id` | string | Yes | The VFS ID |
---
#### List VFS Attachments
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vfs/vfsid/attachments`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vfs/vfsid/attachments?vfs-id={vfs-id}&api_token={api_token}
```
**Description**: List all attachments for a VFS
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vfs-id` | string | Yes | The VFS ID |
---
### Category: VPCs
#### List VPCs
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vpcs`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs?per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all VPCs in your account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Create VPC
**Method**: `POST` | **LowCodeAPI Path**: `/v2/vpcs`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs?api_token={api_token}
```
**Description**: Create a new VPC
**Request Body**:
```json
{
"region": "<string>"
}
```
---
#### Get VPC
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vpcs/vpcid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs/vpcid?vpc-id={vpc-id}&api_token={api_token}
```
**Description**: Get information about a VPC
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vpc-id` | string | Yes | The VPC ID |
---
#### Update VPC
**Method**: `PUT` | **LowCodeAPI Path**: `/v2/vpcs/vpcid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs/vpcid?vpc-id={vpc-id}&api_token={api_token}
```
**Description**: Update a VPC
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vpc-id` | string | Yes | The VPC ID |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete VPC
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/vpcs/vpcid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs/vpcid?vpc-id={vpc-id}&api_token={api_token}
```
**Description**: Delete a VPC
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vpc-id` | string | Yes | The VPC ID |
---
#### List VPC Attachments
**Method**: `GET` | **LowCodeAPI Path**: `/v2/vpcs/vpcid/attachments`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs/vpcid/attachments?vpc-id={vpc-id}&per_page={per_page}&cursor={cursor}&api_token={api_token}
```
**Description**: List all attachments for a VPC
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vpc-id` | string | Yes | The VPC ID |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`per_page` | number | No | Number of items requested per page. Default is 100 and Max is 500 |
|`cursor` | string | No | Cursor for paging |
---
#### Attach VPC to Resource
**Method**: `POST` | **LowCodeAPI Path**: `/v2/vpcs/vpcid/attachments`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs/vpcid/attachments?vpc-id={vpc-id}&api_token={api_token}
```
**Description**: Attach a VPC to a resource
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vpc-id` | string | Yes | The VPC ID |
**Request Body**:
```json
{
"instance_id": "<string>"
}
```
---
#### Detach VPC from Resource
**Method**: `DELETE` | **LowCodeAPI Path**: `/v2/vpcs/vpcid/attachments/attachmentid`
**Full URL**:
```
https://api.lowcodeapi.com/vultr/v2/vpcs/vpcid/attachments/attachmentid?vpc-id={vpc-id}&vpc-attachment-id={vpc-attachment-id}&api_token={api_token}
```
**Description**: Detach a VPC from a resource
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vpc-id` | string | Yes | The VPC ID |
|`vpc-attachment-id` | string | Yes | The VPC Attachment ID |
---
## Complete Endpoint Reference
For a complete list of all 185 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/vultr/definition`
- **Official Provider Documentation**: https://www.vultr.com/api