https://github.com/unixorn/nebula-docs

Last synced: 3 months ago
JSON representation
Host: GitHub
URL: https://github.com/unixorn/nebula-docs
Owner: unixorn
License: mit
Created: 2022-06-16T23:06:27.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-07-14T19:11:48.000Z (almost 3 years ago)
Last Synced: 2025-01-29T09:22:21.706Z (5 months ago)
Size: 16.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # Nebula API

[Headers](#headers)

[Authentication](#authentication)

[RPC API](#rpc-api)

[Routes](#routes)

* [Users](#users)

  + [Create user](#create-user)

  + [Update user](#update-user)

  + [Get user](#get-user)

  + [Get users](#get-users)

  + [Delete user](#delete-user)

* [Projects](#projects)

  + [Create project](#create-project)

  + [Update project](#update-project)

  + [Get project](#get-project)

  + [Get projects](#get-projects)

  + [Get project users](#get-project-users)

  + [Create project role](#create-project-role)

  + [Create project user](#create-project-user)

  + [Delete project user](#delete-project-user)

  + [Delete project](#delete-project)

* [Platforms](#platforms)

  + [Create platform](#create-platform)

  + [Update platform](#update-platform)

  + [Get platforms](#get-platforms)

  + [Delete platform](#delete-platform)

* [Hosts](#hosts)

  + [Update host](#update-host)

  + [Upsert hosts](#upsert-hosts)

  + [Update host data](#update-host-data)

  + [Filter hosts](#filter-hosts)

  + [Get hosts](#get-hosts)

  + [Get host](#get-host)

  + [Delete host](#delete-host)

* [Host Groups](#host-groups)

  + [Get host group](#get-host-group)

  + [Get host group item count](#get-host-group-item-count)

  + [Get host groups](#get-host-groups)

  + [Get host group items](#get-host-group-items)

  + [Filter host group](#filter-host-group)

  + [Create host group selected](#create-host-group-selected)

  + [Create host group item](#create-host-group-item)

  + [Create host group items](#create-host-group-items)

  + [Update host group](#update-host-group)

  + [Get host filter](#get-host-filter)

  + [Create host group filtered](#create-host-group-filtered)

  + [Update host filter](#update-host_filter)

  + [Delete host group items by host](#delete-host-group-items-by-host)

  + [Delete host group item](#delete-host-group-item)

  + [Delete host group](#delete-host-group)

* [Runbooks](#runbooks)

  + [Create runbook](#create-runbook)

  + [Update runbook](#update-runbook)

  + [Get runbooks](#get-runbooks)

  + [Get runbook](#get-runbook)

  + [Delete runbook](#delete-runbook)

* [Jobs](#jobs)

  + [Create job](#create-job)

  + [Rerun job](#rerun-job)

  + [Get job](#get-job)

  + [Get jobs](#get-jobs)

  + [Delete job](#delete-job)

  + [Get job results](#get-job-results)

  + [Get tasks](#get-tasks)

  + [Get work](#get-work)

* [Cvars](#cvars)

  + [Create cvar](#create-cvar)

  + [Update cvar](#update-cvar)

  + [Get cvars](#get-cvars)

  + [Get cvar](#get-cvar)

  + [Delete cvar](#delete-cvar)

* [Cron](#cron)

  + [Create job schedule](#create-job-schedule)

  + [Update job schedule](#update-job-schedule)

  + [Delete job schedule](#delete-job-schedule)

  + [Pause job schedule](#pause-job-schedule)

  + [Resume job schedule](#resume-job-schedule)

* [Agents](#agents)

  + [Get agents](#get-agents)

## Headers

```

Content-Type: application/json

```

## Authentication

```

Basic Auth

```

## RPC API

All RPC API calls are HTTP POST requests.

And all URLs have the format:

`http[s]//:host/:api_version/rpc/:function_name`

There can be different versions of a function with the same API verision,

usually denoted by `:function_name_:version`.

This is reserved for backwards compatibility.

## Routes

The route documentation omits the URL host property.

### Users

#### Create User

`POST /v1/rpc/create_user`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update User

`POST /v1/rpc/update_user`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get User

`POST /v1/rpc/get_user`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Users

`POST /v1/rpc/get_users`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete User

`POST /v1/rpc/delete_user`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Projects

#### Create Project

`POST /v1/rpc/create_project`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Project

`POST /v1/rpc/update_project`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Project

`POST /v1/rpc/get_project`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Projects

`POST /v1/rpc/get_projects`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Project Users

`POST /v1/rpc/get_project_users`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Create Project Role

`POST /v1/rpc/create_project_role`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Create Project User

`POST /v1/rpc/create_project_user`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Project User

`POST /v1/rpc/delete_project_user`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Project

`POST /v1/rpc/delete_project`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Platforms

#### Create Platform

`POST /v1/rpc/create_platform`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Platform

`POST /v1/rpc/update_platform`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Platforms

`POST /v1/rpc/get_platforms`

Request

```javascript

{

  "project_id": integer

}

```

Response

```javascript

[{

  "platform_id": integer,

  "platform_name": text,

  "project_id": integer,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}, ...]

```

#### Delete Platform

`POST /v1/rpc/delete_platform`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Hosts

#### Update Host

`POST /v1/rpc/update_host`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Upsert Hosts

`POST /v1/rpc/upsert_hosts`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Host Data

This is user data for a host.

`POST /v1/rpc/update_host_data`

Request

```javascript

{

  "host_id": uuid,

  "project_id": integer,

  "data": json

}

```

Response

```javascript

{"status": "success"}

```

#### Filter Hosts

`POST /v1/rpc/filter_hosts_v4`

Request

```javascript

{

  "platform_id": integer || array,

  "project_id": integer,

  "mfilter": jsonpath (optional),

  "ufilter": jsonpath (optional),

  "host_locked": boolean (optional),

  "limit": integer (optional),

  "offset": integer (optional)

}

```

Response

```javascript

[{

  "host_id": uuid,

  "platform_host_id": text,

  "host_ip": inet,

  "host_name": text,

  "project_id": integer,

  "platform_id": integer,

  "metadata": json,

  "stale": boolean,

  "created": timestamp,

  "updated": timestamp,

  "data": json,

  "host_locked": boolean,

  "total_hosts": integer

}, ...]

```

#### Get Hosts

`POST /v1/rpc/get_hosts`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Host

`POST /v1/rpc/get_host`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Host

NOTE: TBA

`POST /v1/rpc/delete_host`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Host Groups

#### Get Host Group

`POST /v1/rpc/get_host_group`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Host Group Item Count

`POST /v1/rpc/get_host_group_item_count`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Host Groups

`POST /v1/rpc/get_host_groups`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Host Group Items

`POST /v1/rpc/get_host_group_items_v4`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Filter Host Group

`POST /v1/rpc/filter_host_group_v4`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Create Host Group Selected

`POST /v1/rpc/create_host_group_selected`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Create Host Group Item

`POST /v1/rpc/create_host_group_item`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Create Host Group Items

`POST /v1/rpc/create_host_group_items_v2`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Host Group

`POST /v1/rpc/update_host_group`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Host Filter

`POST /v1/rpc/get_host_filter`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Create Host Group Filtered

`POST /v1/rpc/create_host_group_filtered`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Host Filter

`POST /v1/rpc/update_host_filter`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Host Group Items by Host

`POST /v1/rpc/delete_host_group_items_by_host`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Host Group Item

`POST /v1/rpc/delete_host_group_item`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Host Group

`POST /v1/rpc/delete_host_group`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Runbooks

#### Create Runbook

`POST /v1/rpc/create_runbook`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Runbook

`POST /v1/rpc/update_runbook`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Get Runbooks

Returns max 500 runbooks.

Optionally, page through all

runbooks using limit

and offset.

`POST /v1/rpc/get_runbooks`

Request

```javascript

{

  "project_id": integer,

  "limit": integer (optional),

  "offset: integer (optional)

}

```

Response

```javascript

[{

  "runbook_id": integer,

  "runbook_name": text,

  "template": text,

  "caption": text,

  "repo": text,

  "branch": text,

  "queue_name": text,

  "job_type": text,

  "markdown": text,

  "project_id": integer,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}, ...]

```

#### Get Runbook

`POST /v1/rpc/get_runbook`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Runbook

`POST /v1/rpc/delete_runbook`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Agents

#### Get Agents

`POST /v1/rpc/get_agents`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Jobs

#### Create Job

`POST /v1/rpc/create_job`

Request

```javascript

{

  "runbook_id": integer,

  "project_id": integer,

  "queue_name": text (optional),

  "template": text (optional),

  "repo": text (optional),

  "branch": text (optional),

  "job_type": text (optional),

  "data": json (optional)

}

```

Response

```javascript

{"job_id": bigint}

```

#### Rerun Job

`POST /v1/rpc/rerun_job`

Reruns a job, creating a new job item,

returning the new job_id.

Request

```javascript

{

  "job_id": bigint,

  "project_id": integer

}

```

Response

```javascript

{"job_id": bigint}

```

#### Get Job

`POST /v1/rpc/get_job`

Request

```javascript

{

  "job_id": bigint,

  "project_id": integer

}

```

Response

```javascript

[{

  "job_id": bigint,

  "runbook_id": integer,

  "project_id": integer,

  "queue_name": text,

  "template": text,

  "repo": text,

  "branch": text,

  "job_type": text,

  "status": text,

  "handler": text,

  "started": timestamp,

  "finished: timestamp,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}]

```

#### Get Jobs

`POST /v1/rpc/get_jobs`

Request

```javascript

{

  "project_id": integer,

  "limit": integer,

  "offset": integer

}

```

Response

```javascript

[{

  "job_id": bigint,

  "runbook_id": integer,

  "project_id": integer,

  "queue_name": text,

  "template": text,

  "repo": text,

  "branch": text,

  "job_type": text,

  "status": text,

  "handler": text,

  "started": timestamp,

  "finished: timestamp,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}, ...]

```

#### Delete Job

`POST /v1/rpc/delete_job`

Request

```javascript

{

  "job_id": bigint,

  "project_id": integer

}

```

Response

```javascript

{"status": "success"}

```

#### Get Job Results

`POST /v1/rpc/get_job_results`

Request

```javascript

{

  "job_id": bigint,

  "project_id": integer

}

```

Response

```javascript

[{

  "job_result_id": bigint,

  "job_id": bigint,

  "project_id": integer,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}, ...]

```

#### Get Tasks

`POST /v1/rpc/get_tasks`

Request

```javascript

{

  "job_id": bigint,

  "project_id": integer

}

```

Response

```javascript

[{

  "task_id": bigint,

  "job_id": bigint,

  "project_id": integer,

  "task_name": text,

  "status" text,

  "created": timestamp,

  "started": timestamp,

  "finished": timestamp,

  "data": json

}, ...]

```

#### Get Work

`POST /v1/rpc/get_work`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

### Cvars

#### Create Cvar

`POST /v1/rpc/create_cvar`

Request

```javascript

{

  "cvar_name": text,

  "cvar_value": text,

  "project_id": integer,

  "encrypt": bool

}

```

Response

```javascript

{"cvar_id": integer}

```

#### Update Cvar

`POST /v1/rpc/update_cvar`

Request

```javascript

{

  "cvar_id": integer,

  "project_id": integer,

  "cvar_name": text,

  "cvar_value": text,

  "encrypt": bool

}

```

Response

```javascript

{"status": "success"}

```

#### Get Cvars

`POST /v1/rpc/get_cvars`

Request

```javascript

{

  "project_id": integer,

  "decrypt": bool

}

```

Response

```javascript

[{

  "cvar_id": integer,

  "cvar_name": text,

  "cvar_value": text,

  "project_id": integer,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}, ...]

```

#### Get Cvar

`POST /v1/rpc/get_cvar`

Request

```javascript

{

  "cvar_id": integer,

  "project_id": integer

}

```

Response

```javascript

[{

  "cvar_id": integer,

  "cvar_name": text,

  "cvar_value": text,

  "project_id": integer,

  "created": timestamp,

  "updated": timestamp,

  "data": json

}]

```

#### Delete Cvar

`POST /v1/rpc/delete_cvar`

Request

```javascript

{

  "cvar_id": integer,

  "project_id": integer

}

```

Response

```javascript

{"status": "success"}

```

### Cron

#### Create Job Schedule

`POST /v1/rpc/create_job_schedule`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Update Job Schedule

`POST /v1/rpc/update_job_schedule`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Delete Job Schedule

`POST /v1/rpc/delete_job_schedule`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Pause Job Schedule

`POST /v1/rpc/pause_job_schedule`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```

#### Resume Job Schedule

`POST /v1/rpc/resume_job_schedule`

Request

```javascript

{"foo": "bar"}

```

Response

```javascript

{"status": "success"}

```
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/unixorn/nebula-docs

Awesome Lists containing this project

README
