PROKI API documentation version 1

You are viewing the documentation for PROKI API - a project that aims to deliver more flexible way for administrators and IT security personnel to obtain incident data from the PROKI database concerning their network.

We welcome any feedback and suggestions for improvement. Email us at proki@csirt.cz

The server returns a json response. It should always contain status field (with value OK or ERROR) and message (human readable message).

Base URL for this version of PROKI API is https://proki.csirt.cz/api/1/

/{api-key}

get

Base resource for retrieval of incident data. Defaults to /data/today.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

HTTP status code 200

This response is received when the request was successfull. Note that the "data" field can be empty. Without further specification this returns the same data as /data/today.

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for today.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for yesterday.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for the current week. Running this on Thursday will return incident data from Monday to Thursday.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for the current month. Running this on 15th of May will return incident data from 1st of May to 15h of May.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for the specified month.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

  • year: required (integer)
  • month: required (integer)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

HTTP status code 404

This response is received when the resource is missing. Usually it is caused by selecting a date that is in the future.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Not found"
}

get

Returns incident data for today (same as /data/today or just /data).

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for the specified date (one day).

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

  • year: required (integer)
  • month: required (integer)
  • day: required (integer)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

HTTP status code 404

This response is received when the resource is missing. Usually it is caused by selecting a date that is in the future.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Not found"
}

get

Returns incident data for the past N days.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

  • number-of-days: required (string)

    Number of days you want incident data for.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

get

Returns incident data for N days starting on the specified date (included).

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • api-key: required (string)

    API-KEY for authentication to access PROKI API.

  • number-of-days: required (string)

    Number of days you want incident data for.

  • year: required (integer)
  • month: required (integer)
  • day: required (integer)

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "status": "OK",
  "message": "Data successfully retrieved for a time period from {start-date} to {end-date}",
  "data": []
}

HTTP status code 401

This response is received when the API-KEY is not valid.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Unauthorized"
}

HTTP status code 404

This response is received when the resource is missing. Usually it is caused by selecting a date that is in the future.

Body

Media type: application/json

Type: json

Content:

{
  "status": "ERROR",
  "message": "Not found"
}

/reset-key

get

Generates a link for resetting your API-KEY. The link is sent to your abuse email. Note that it is always going to result in "OK" status even when the email is not registered for PROKI API. This is to prevent user enumeration.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • abuse-email: required (string)

    Abuse email registered for PROKI API.

HTTP status code 200

This response is received even when the submitted abuse email is not registered for PROKI API.

Body

Media type: application/json

Type: object

Example:

{
  "status": "OK",
  "message": "Link to reset your API-KEY has been sent to your email."
}

/action

get

Resets your API-KEY. The new API-KEY is sent to your abuse email.

get

Details of request and response parameters.

Details of request and response parameters.

URI Parameters

  • token: required (string)

    The token generated for API-KEY reset. It is obtained as a part of the link from /reset-key.

HTTP status code 200

This response is received when the submitted token is valid.

Body

Media type: application/json

Type: object

Example:

{
  "status": "OK",
  "message": "You have successfully reset your API-KEY. It has been sent to your email."
}

HTTP status code 400

This response is received when the submitted token is not valid or expired.

Body

Media type: application/json

Type: object

Example:

{
  "status": "ERROR",
  "message": "The link is not valid."
}