Inertia Daemon API Reference (0.6.1)

Download OpenAPI specification:Download

UBC Launch Pad: team@ubclaunchpad.com URL: https://github.com/ubclaunchpad/inertia License: MIT

This is the reference documentation for the Inertia daemon's REST API.

About Inertia

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!

Request Authentication

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.

bearer_auth

JWT issued by Inertia

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Deployment

Start up project

Build and deploy your project

Repository configuration

Authorizations:

bearer_auth

Request Body schema: application/json

stream	boolean Whether or not to stream log output
project	string
build_type	string
build_file_path	string
git_options	object
webhook_secret	string

Responses

201

Project deployment successfully started

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /up

https://$DAEMON_ADDR:$DAEMON_PORT/up

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"stream": true,
"project": "string",
"build_type": "string",
"build_file_path": "string",
"git_options": 
{"remote": "string",
"branch": "string"
},
"webhook_secret": "string"
}

Response samples

201
4XX,5XX

Content type

text/plain

Copy

No deployment detected
Setting up project...
Cloning branch dev from git@github.com:example/example.git...

Shut down project

Shuts down project containers

Authorizations:

bearer_auth

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /down

https://$DAEMON_ADDR:$DAEMON_PORT/down

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": { }
}

Remove project

Reset daemon and remove project from deployment

Authorizations:

bearer_auth

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /reset

https://$DAEMON_ADDR:$DAEMON_PORT/reset

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": { }
}

Update environment variables

Set environment variables

Secrets management

Authorizations:

bearer_auth

Request Body schema: application/json

name required	string
value required	string
encrypt	boolean
remove	boolean

Responses

202

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /env

https://$DAEMON_ADDR:$DAEMON_PORT/env

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"value": "string",
"encrypt": true,
"remove": true
}

Response samples

202
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": { }
}

Retrieve environment variables

Retrieve configured environment variables

Authorizations:

bearer_auth

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /env

https://$DAEMON_ADDR:$DAEMON_PORT/env

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": 
{"variables": 
["KEY1=VAL1",
"KEY2=VAL2"
]
}
}

Webhooks

Accepts incoming payloads from Git hosts (GitHub, GitLab, and Bitbucket)

Repository configuration

Responses

202

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /webhook

https://$DAEMON_ADDR:$DAEMON_PORT/webhook

Response samples

202
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": { }
}

Deployment status check

Check the status of your Inertia deployment

Deployment monitoring

Authorizations:

bearer_auth

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /status

https://$DAEMON_ADDR:$DAEMON_PORT/status

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"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 deployment logs

View logs of the Inertia daemon or project containers

Deployment monitoring

Authorizations:

bearer_auth

query Parameters

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)

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /logs

https://$DAEMON_ADDR:$DAEMON_PORT/logs

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"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..."
]
}
}

Monitoring

Daemon healthcheck

Returns OK if daemon is online and ready

Responses

200

Daemon is online

get /

https://$DAEMON_ADDR:$DAEMON_PORT/

Response samples

Content type

text/plain

Copy

Hello world!

Deployment status check

Check the status of your Inertia deployment

Deployment monitoring

Authorizations:

bearer_auth

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /status

https://$DAEMON_ADDR:$DAEMON_PORT/status

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"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 deployment logs

View logs of the Inertia daemon or project containers

Deployment monitoring

Authorizations:

bearer_auth

query Parameters

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)

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /logs

https://$DAEMON_ADDR:$DAEMON_PORT/logs

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"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..."
]
}
}

Authentication

Validate JWT

Validate your JWT

Authorizations:

bearer_auth

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /user/validate

https://$DAEMON_ADDR:$DAEMON_PORT/user/validate

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": { }
}

Log in as user

Authenticate as a user to Inertia daemon

Team management

Authorizations:

bearer_auth

Request Body schema: application/json

username	string
password	string
totp	string

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /user/login

https://$DAEMON_ADDR:$DAEMON_PORT/user/login

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "string",
"password": "string",
"totp": "string"
}

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": 
{"token": "abcdefg"
}
}

List users

List all currently registered users on the Inertia daemon

Team management

Authorizations:

bearer_auth (admin:true)

Responses

200

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

get /user/list

https://$DAEMON_ADDR:$DAEMON_PORT/user/list

Response samples

200
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all


{"code": 0,
"message": "(example) successfully did something!",
"request_id": "example/2Mch7LMzhj-000023",
"data": 
{"users": 
["bobheadxi",
"mRabitsky",
"seifghazi",
"terryz21",
"theblackathena",
"yaoharry"
]
}
}

Add user

Team management

Authorizations:

bearer_auth (admin:true)

Request Body schema: application/json

username required	string
password required	string
admin	boolean

Responses

201

Success!

4XX,5XX

Something went wrong - refer to the error code and message for more details

post /user/add

https://$DAEMON_ADDR:$DAEMON_PORT/user/add

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"username": "string",
"password": "string",
"admin": true
}

Response samples

201
4XX,5XX

Content type

application/json

Copy

Expand all Collapse all

<