Base URL: /api/v0, Version: 0.1.0
API for interacting with the Fugue Conductor
| Operation | Description | Maps To |
|---|---|---|
| GET /accounts | Get a list of managed accounts |
|
| POST /accounts | Add a new account to the conductor |
|
| DELETE /accounts/{account} | Remove an account from the conductor |
| Operation | Description | |
|---|---|---|
| POST /dry-run | Request a dry-run |
fugue run --dry-run |
| GET /dry-run/{id} | Get a dry-run result |
fugue run --dry-run |
| Operation | Description | Maps To |
|---|---|---|
| GET /processes | Get the running processes |
|
| POST /processes | Create a new fugue process |
|
| GET /processes/{process} | Get details and resources for a process |
|
| PATCH /processes/{process} | Update a process |
|
| DELETE /processes/{process} | Release or kill a process |
|
| PUT /processes/{process}/composition | Update a process with a new composition snapshot |
|
| GET /processes/{process}/history | Get the history for a process |
|
| GET /processes/{process}/ops | Get cloud operations performed on behalf of a Fugue process |
|
| GET /processes/{process}/ops/{job_id} | Get cloud operations performed on behalf of a Fugue process for a specific job. |
| Operation | Description | Maps To |
|---|---|---|
| GET /rbac/archive | Fetch the currently attached policy archive |
|
| GET /rbac/status | Determine if policy is currently applied. |
|
| POST /rbac | Attach a new rbac policy |
|
| DELETE /rbac | Detach the current rbac policy |
| Operation | Description | Maps To |
|---|---|---|
| GET /rbac/users | List the currently declared users |
|
| PUT /rbac/users/{user}/secret | Generate a new secret for the specified user |
| Operation | Description | Maps To |
|---|---|---|
| GET /validations | List validation libraries installed on the Conductor |
|
| POST /validations | Add a new validation library to the Conductor |
|
| GET /validations/{name} | Retrieve validation metadata from the Conductor |
N/A |
| DELETE /validations/{name} | Remove a validation library from the Conductor |
|
| GET /validations/{name}/archive | Retrieve a validation archive from the Conductor |
Username
Your Fugue user
Password
Your Fugue user secret
See Authentication for more information.
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Server error
Uses default content-types: application/json application/x-tar application/octet-stream
The account to manage
Uses default content-types: application/json application/x-tar
Created
| Location | URL of created resource |
string |
Bad request
Unauthorized
Server error
| account | The account ID or name |
path | string |
Uses default content-types: application/json application/x-tar
Removed
Bad request
Unauthorized
Resource not found
Server error
application/octet-stream application/x-tar
A composition snapshot
| command | The command to run for the process |
query | string , x ∈ { KILL , RESUME , RUN , UPDATE , kill , resume , run , update } | |
| process | The process's FID or alias |
query | string | |
| import_resources | Run the import filter |
query | boolean | |
| account | Account ID or name of the processes |
query | string |
Uses default content-types: application/json application/x-tar
Accepted
| Location | URL of the results resource |
string |
Bad request
Unauthorized
Server error
| id | The request ID |
path | string | |
| timeout | Specify a timeout in seconds for the API to wait for a dry run result |
query | integer , { x ∈ ℤ | x ≥ 0 } |
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Resource not found
server error
| account | Account ID or name of the processes |
query | string |
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Server error
application/octet-stream application/x-tar
A composition snapshot
| import_resources | Run the import filter |
query | boolean | |
| account | Account ID of the processes |
query | string | |
| alias | Alias to associate with the process |
query | string |
Uses default content-types: application/json application/x-tar
Created
| Location | URL of created resource |
string |
Bad request
Unauthorized
Server error
| kill | Clean up the processes underlying resources |
query | boolean | |
| process | The FID or alias of the process |
path | string |
Uses default content-types: application/json application/x-tar
Accepted
Released
Bad request
Unauthorized
Resource not found
Server error
Uses default content-types: application/json application/x-tar application/octet-stream
The properties to update
The new alias
The requested action
When enabled fugue will correct configuration drift.
When enabled fugue will not allow a process's state to be transitioned.
| process | The FID or alias of the process |
path | string |
Uses default content-types: application/json application/x-tar
Process update accepted
The FID of the process
The current state of enforcement of the process
The current lock state of the process
The alias of the process
Identifier for this transaction
| Location | URL of the results resource |
string |
Bad request
Unauthorized
Process not found
Illegal state change
Server error
application/octet-stream application/x-tar
A composition snapshot
| process | The FID or alias of the process |
path | string |
Uses default content-types: application/json application/x-tar
Accepted
| Location | URL of the results resource |
string |
Bad request
Unauthorized
Resource not found
Server error
| process | The FID or alias of the process |
path | string | |
| start | Specify a start time in "mm/dd/YYYY HH:MM" format |
query | string | |
| end | Specify an end time in "mm/dd/YYYY HH:MM" format |
query | string |
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Resource not found
Server error
| process | The FID or alias of the process |
path | string | |
| start | Specify an UTC start time in "mm/dd/YYYY HH:MM" format |
query | string | |
| end | Specify an UTC end time in "mm/dd/YYYY HH:MM" format |
query | string | |
| first | Filter for the first batch of operations performed |
query | boolean | |
| last | Filter for the last batch of operations performed |
query | boolean |
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Resource not found
Server error
| process | The FID or alias of the process |
path | string | |
| job_id | A single job_id |
path | string | |
| start | Specify an UTC start time in "mm/dd/YYYY HH:MM" format |
query | string | |
| end | Specify an UTC end time in "mm/dd/YYYY HH:MM" format |
query | string |
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Resource not found
Server error
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Resource not found
Server error
application/octet-stream application/x-tar
A composition snapshot
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Server error
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Server error
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Server error
| user | path | string |
Uses default content-types: application/json application/x-tar
New secret for the user
Bad request
Unauthorized
Resource not found
Server error
| prefix | Filter the list to libraries that start with prefix |
query | string |
Uses default content-types: application/json application/x-tar
List of validations
Bad request
Unauthorized
Server error
application/octet-stream application/x-tar
A composition snapshot
| name | Name of the new validation library |
query | string |
Uses default content-types: application/json application/x-tar
New validation
Bad request
Unauthorized
Server error
| name | Name of the new validation library |
path | string |
Uses default content-types: application/json application/x-tar
OK
Bad request
Unauthorized
Resource not found
server error
| name | Name of the new validation library |
path | string |
Uses default content-types: application/json application/x-tar
Validation
Bad request
Unauthorized
Resource not found
server error
Represents an account
Represents an async dry-run request
The id of the request
The request status
A list of errors