PDFreactor Web Service Monitoring REST API (11.4.0)

This is the monitoring REST API definition and documentation of the PDFreactor Web Service. To use the monitoring API, an adminKey has to be configured on the server.

Service information

get /server
http://localhost:9423/service/monitor/server

Retrieves information about the PDFreactor Web Service that is currently running.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.

Response samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "id": "string",
  • "state": "string",
  • "server":
    {
    },
  • "plugins":
    [
    ],
  • "parameters":
    [
    ],
  • "version":
    {
    },
  • "date": "2021-09-24T13:25:26Z",
  • "supportsRestart": true
}

Conversion information

get /conversions
http://localhost:9423/service/monitor/conversions

Retrieves information about the conversions on the server.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.

Response samples

Content type
Copy
Expand all Collapse all
{
  • "failedConversions": 0,
  • "finishedConversions": 0,
  • "queuedConversions":
    {
    },
  • "runningConversions":
    {
    },
  • "serviceId": "string"
}

Running conversion information

get /conversions/running
http://localhost:9423/service/monitor/conversions/running

Retrieves information about the running conversions on the server.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.

Response samples

Content type
Copy
Expand all Collapse all
{
  • "amount": 0,
  • "conversions":
    [
    ],
  • "serviceId": "string"
}

Queued conversion information

get /conversions/queued
http://localhost:9423/service/monitor/conversions/queued

Retrieves information about the queued conversions on the server.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.

Response samples

Content type
Copy
Expand all Collapse all
{
  • "amount": 0,
  • "conversions":
    [
    ],
  • "serviceId": "string"
}

Running conversion information

get /conversions/finished
http://localhost:9423/service/monitor/conversions/finished

Retrieves information about the finished conversions on the server.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.

Successful conversion information

get /conversions/finished/successful
http://localhost:9423/service/monitor/conversions/finished/successful

Retrieves information about the successfully finished conversions on the server.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.

Failed conversion information

get /conversions/finished/failed
http://localhost:9423/service/monitor/conversions/finished/failed

Retrieves information about the erroneously finished conversions on the server.

query Parameters
adminKey
string

The admin key to authenticate the request.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied admin key was invalid.

503

The PDFreactor Web Service is not available.