Skip to content

Planned RestAPI Endpoints #1

@pschilly

Description

@pschilly
## Category: Instance ##

# Start a server based on the provided name.
Endpoint:   /instance/start
Method:     [POST]
Params:     - server_name   [required]

# Stop a server based on the provided name.
Endpoint:   /instance/stop
Method:     [POST]
Params:     - server_name   [required]

# Restart a server based on the provided name.
Endpoint:   /instance/restart
Method:     [POST]
Params:     - server_name   [required]

## Category: Mission ##

# Return a listing of available missions
Endpoint:   /instance/missions
Method:     [GET]
Params:     - server_name   [required]

# Pause the mission on the provided server.
Endpoint:   /instance/mission/pause
Method:     [POST]
Params:     - server_name   [required]

# Unpause the mission on the provided server.
Endpoint:   /instance/mission/unpause
Method:     [POST]
Params:     - server_name   [required]

# Restart the mission on the provided server.
Endpoint:   /instance/mission/restart
Method:     [POST]
Params:     - server_name   [required]

# Load the provided mission on the provided server.
Endpoint:   /instance/mission/pause
Method:     [POST]
Params:     - server_name   [required]
            - mission_name  [required]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions