Gaffer REST API Resources

Jobs

Jobs are the configurations that can be used to launch the processes in Gaffer.

Resource Description
GET /sessions List all sessions/application available on this node.
GET /jobs List all jobs configuration available on this node.
GET /jobs/sessionid Get all resources available on this machine. A resource can have multiple jobs defined for it. This can represent a procfile or an an application. The default resource is named default.
POST /jobs/sessionid Load a new job configuration for this resource in a session.
GET /jobs/sessionid/job Get a job configuration
PUT /jobs/sessionid/job Update a job configuration.
DELETE /jobs/sessionid/job Unload a job configuration and stop all processes related to this configuration.
GET /jobs/sessionid/job/stats aggregate all processes stats for this job configuration
GET /jobs/sessionid/job/numprocesses Get the number of processes set for this job configuration
POST /jobs/sessionid/job/numprocesses Increase or decrease the number of processes set for this job configuration
POST /jobs/sessionid/job/signal Send a signal to all processes running with this configuration
GET /jobs/sessionid/job/state Get the current job status
POST /jobs/sessionid/job/state Start/Stop/Restart a job
GET /jobs/sessionid/job/pids Get all pids for a job
POST /jobs/sessionid/job/commit Send a one-off command to the node using a job config

Processes

API to handle directly launched OS processes.

Resource Description
GET /pids Get the list of all active processes IDs.
GET /pid Get the informations of an active process
DELETE /pid Stop a process
POST /pid/signal Send a signal to a process
GET /pid/stats Get current statistics of a process

Auth

Authenticate to gaffer to get an authorization key. See the Authentification documentation.

Resource Description
GET /auth Send a BASIC AUTH requesGET to fetch an authorization key.

Keys

API to manage authorizations keys in a gaffer Node. The authorizations keys give certains rights to the users in gaffer. You need to be a node admin to access to this api.

Resource Description
GET /keys List all keys available on this node
POST /keys Create a new key.
GET /keys/key Fetch the key details.
DELETE /keys/key Delete a key

Miscellaneous

Resource Description
GET / Return gaffer main informations
GET /ping Ping a gaffer return. Useful to test it the nide is alive.
GET /version Return the gaffer version