Generic Service Features

All Dream services have this standard set of features.



Verb:Suffix Description
DELETE:
Destroy the service.
GET:@about
Retrieve a human readable description of the service.
GET:@blueprint
Retrieve a machine readable description of the service.
DELETE:@config
Stop the service.
GET:@config
Read the service configuration.
PUT:@config
Start the service with a new configuration.



DELETE:

Destroy the service.  The service is stopped and is de-allocated from memory.

Response


Status Description
Ok (200) No content
Version History

Aqua: added



GET:@about

Shows a HTML form showing the services blueprint.

Response


Status Description
Ok (200) HTML form showing the services blueprint
Version History

Crimson: renamed from '@inspect' to '@about'

Aqua: added



GET:@blueprint

Returns the service blueprint.

Response
Status Description
Ok (200) Service blueprint information
Version History

Crimson: added



DELETE:@config


Stops the service, but does not delete it.

Response
Status Description
Ok (200) No content
Version History

Crimson: added



GET:@config


Returns the service configuration information.

Response
Status Description
Ok (200) Service configuration information
Version History

Aqua: added



PUT:@config


Changes the service configuration by stopping and restarting it.

Response
Status Description
Ok (200) No content
Version History

Crimson: added

Tag page
You must login to post a comment.