Skip to main content

Service Management

This section will cover the API endpoints for managing services, including creating, listing, and deleting services.

Available Endpoints​

List Services​

  • Endpoint: services/<slug:stype>/list
  • Method: GET
  • Description: Retrieves a list of all services of a specific type.
  • Request Body: None.
  • Response Body: A JSON array of Service objects.

Get Service Details​

  • Endpoint: services/<slug:stype>/<int:sid>
  • Method: GET
  • Description: Fetches detailed information about a specific service.
  • Request Body: None.
  • Response Body: A single Service object.

Create Service​

  • Endpoint: services/<slug:stype>/create
  • Method: POST
  • Description: Creates a new service of a specific type.
  • Request Body: A JSON object with service-specific creation parameters. The required fields depend on the stype.
  • Response Body: A JSON object confirming the creation.

Get Create Parameters​

  • Endpoint: services/<slug:stype>/<slug:sprovider>/params
  • Method: GET
  • Description: Get required parameters, parameter types, and stock hints for a given stype and sprovider
  • Request Body: None
  • Response Body: A single JSON dict containing service specific data. See the specific service files to understand more.

Delete Service​

  • Endpoint: services/<slug:stype>/<int:sid>/delete
  • Method: POST
  • Description: Deletes a specific service.
  • Request Body: None.
  • Response Body: A JSON object confirming the deletion.