How to manage your configuration via the REST API

All requests to manage your configuration via the REST API need to be authenticated. For this create an API token with the role Administrator and add the token as header to the request:

Authorization: Bearer <your API token>

Servers

Get all servers

GET https://issue-publisher.catworkx.de/rest/remote-server

Add server

POST https://issue-publisher.catworkx.de/rest/remote-server

The expected request body has the same format as the response of the Get server call.

Get server

GET https://issue-publisher.catworkx.de/rest/remote-server/{id}

Replace {id} with the UUID of the server.

Update server

PUT https://issue-publisher.catworkx.de/rest/remote-server/{id}

Replace {id} with the UUID of the server.

The expected request body has the same format as the response of the Get server call.

Delete server

DELETE https://issue-publisher.catworkx.de/rest/remote-server/{id}

Replace {id} with the UUID of the server.

Operations

Get all operations

GET https://issue-publisher.catworkx.de/rest/operation

Add operation

POST https://issue-publisher.catworkx.de/rest/operation

The expected request body has the same format as the response of the Get operation call.

Get operation

GET https://issue-publisher.catworkx.de/rest/operation/{id}

Replace {id} with the UUID of the operation.

Update operation

PUT https://issue-publisher.catworkx.de/rest/operation/{id}

Replace {id} with the UUID of the operation.

The expected request body has the same format as the response of the Get operation call.

Delete operation

DELETE https://issue-publisher.catworkx.de/rest/operation/{id}

Replace {id} with the UUID of the operation.

Templates

Get all templates

GET https://issue-publisher.catworkx.de/rest/template

Add template

POST https://issue-publisher.catworkx.de/rest/template

The expected request body has the same format as the response of the Get template call.

Get template

GET https://issue-publisher.catworkx.de/rest/template/{id}

Replace {id} with the UUID of the template.

Update template

PUT https://issue-publisher.catworkx.de/rest/template/{id}

Replace {id} with the UUID of the template.

The expected request body has the same format as the response of the Get template call.

Delete template

DELETE https://issue-publisher.catworkx.de/rest/template/{id}

Replace {id} with the UUID of the template.