Download OpenAPI specification:Download
This is the reference documentation for the Inertia daemon's REST API.
For a more general usage guide, check out the Inertia Usage Guide. A CLI reference is also available.
If you find any issues, please feel free to open an issue!
Inertia issues JWTs for request authentication. Using the CLI, a persistent key is generated - for general use, you should create a user and log in to receive a user-specific JWT.
Build and deploy your project
stream | boolean Whether or not to stream log output |
project | string |
build_type | string |
build_file_path | string |
git_options | object |
webhook_secret | string |
Project deployment successfully started
Something went wrong - refer to the error code and message for more details
{- "stream": true,
- "project": "string",
- "build_type": "string",
- "build_file_path": "string",
- "git_options": {
- "remote": "string",
- "branch": "string"
}, - "webhook_secret": "string"
}
No deployment detected Setting up project... Cloning branch dev from git@github.com:example/example.git...
Shuts down project containers
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": { }
}
Reset daemon and remove project from deployment
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": { }
}
Set environment variables
name required | string |
value required | string |
encrypt | boolean |
remove | boolean |
Success!
Something went wrong - refer to the error code and message for more details
{- "name": "string",
- "value": "string",
- "encrypt": true,
- "remove": true
}
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": { }
}
Retrieve configured environment variables
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "variables": [
- "KEY1=VAL1",
- "KEY2=VAL2"
]
}
}
Accepts incoming payloads from Git hosts (GitHub, GitLab, and Bitbucket)
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": { }
}
Check the status of your Inertia deployment
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "version": "string",
- "branch": "string",
- "commit_hash": "string",
- "commit_message": "string",
- "build_type": "string",
- "containers": [
- "/docker-compose",
- "/server"
], - "build_active": true,
- "new_version_available": "string"
}
}
View logs of the Inertia daemon or project containers
container | string Example: container=/docker-compose Name of container to fetch logs for - leave blank for Inertia daemon logs |
stream | boolean Example: stream=true Whether or not to upgrade connection to a websocket |
entries | integer Example: entries=500 Number of lines of logs to fetch (default 500) |
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "token": [
- "No deployment detected",
- "Setting up project...",
- "Cloning branch dev from git@github.com:example/example.git..."
]
}
}
Check the status of your Inertia deployment
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "version": "string",
- "branch": "string",
- "commit_hash": "string",
- "commit_message": "string",
- "build_type": "string",
- "containers": [
- "/docker-compose",
- "/server"
], - "build_active": true,
- "new_version_available": "string"
}
}
View logs of the Inertia daemon or project containers
container | string Example: container=/docker-compose Name of container to fetch logs for - leave blank for Inertia daemon logs |
stream | boolean Example: stream=true Whether or not to upgrade connection to a websocket |
entries | integer Example: entries=500 Number of lines of logs to fetch (default 500) |
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "token": [
- "No deployment detected",
- "Setting up project...",
- "Cloning branch dev from git@github.com:example/example.git..."
]
}
}
Validate your JWT
Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": { }
}
Authenticate as a user to Inertia daemon
username | string |
password | string |
totp | string |
Success!
Something went wrong - refer to the error code and message for more details
{- "username": "string",
- "password": "string",
- "totp": "string"
}
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "token": "abcdefg"
}
}
List all currently registered users on the Inertia daemon
admin:true
) Success!
Something went wrong - refer to the error code and message for more details
{- "code": 0,
- "message": "(example) successfully did something!",
- "request_id": "example/2Mch7LMzhj-000023",
- "data": {
- "users": [
- "bobheadxi",
- "mRabitsky",
- "seifghazi",
- "terryz21",
- "theblackathena",
- "yaoharry"
]
}
}
Register a new user in the Inertia daemon
admin:true
) username required | string |
password required | string |
admin | boolean |
Success!
Something went wrong - refer to the error code and message for more details
{- "username": "string",
- "password": "string",
- "admin": true
}
<