Registries

List all registries

Request

Definition

GET /api/v1/reports/registries

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Query string parameters

Parameter	Type	Request	Description
paginate	boolean	Yes	If the result must be paginated.
page	integer	Yes if paginate is true	Page index.
page_size	integer	Yes if paginate is true	Number of items displayed per page.
creation_status	string	No	Filters results related to the specified report creation status.
id	integer	No	Filters results related to the specified ID.
id_list	array<string>	No	Filters results related to any of the IDs contained in the specified list.
report_schedule_id	string	No	Filters results related to the specified schedule ID.
report_schedule_id_list	array<string>	No	Filters results related to any of the schedule IDs contained in the specified list.
scheduled_by	string	No	Filters results related to the user who created the report.
type	string	No	Filters results related to the specified report type.

Response

Status codes

Status code	Message
200	"List of report registries"
400	"Error with pagination fields"
403	"Forbidden"

Body

Attributes

• data.registries.created_at integer

  Creation date and time of the registry in UNIX format (microseconds).

• data.registries.creation_status string

  Indicates the creation status.

• data.registries.hosts array<string>

  Hosts for which the report was generated.

• data.registries.id string

  Registry ID.

• data.registries.report_schedule_id string

  ID of the schedule associated to the registry.

• data.registries.scheduled_by string

  User who shceduled registry.

• data.registries.start_timestamp integer

  Date and time when the report was started in UNIX format (microseconds).

• data.registries.timezone string

  Timezone associated with the time interval for which the report was generated.

• data.registries.type string

  Registry type.

Example

{
"data": {
    "registries": [
    {
        "created_at": 1705497089045145,
        "creation_status": "in_progress",
        "end_timestamp": 1681941600000000,
        "hosts": [
        "www.service-test-host.it"
        ],
        "id": "e8xx17f7-xxxx-46d7-xxxx-2bxx46xxxc38",
        "report_schedule_id": "4xx33x86-xxxx-4bab-xxxx-baxxdxxx4461",
        "scheduled_by": "test_user",
        "start_timestamp": 1681855200000000,
        "timezone": "Europe/Rome",
        "type": "generic"
    }
    ]
},
"message": "List of report registries",
"pagination": {
    "first": 1,
    "last": 1,
    "page": 0,
    "total_count": 1,
    "total_pages": 1
},
"status": "ok"
}

List a specific registry

Request

Definition

GET /api/v1/reports/registries/{registry_id}

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Response

Status codes

Status code	Message
200	"Report registry retrieved"
400	"Error retrieving registry"
400	"Error with pagination fields"
403	"Forbidden"

Body

{
  "data": {
    "registry": {
      "created_at": 1705497089722671,
      "creation_status": "in_progress",
      "end_timestamp": 1681941600000000,
      "hosts": [
        "www.service-test-host.it"
      ],
      "id": "e8xx17f7-xxxx-46d7-xxxx-2bxx46xxxc38",
      "report_schedule_id": "4xx33x86-xxxx-4bab-xxxx-baxxdxxx4461",
      "scheduled_by": "test_user",
      "start_timestamp": 1681855200000000,
      "timezone": "Europe/Rome",
      "type": "generic"
    }
  },
  "message": "Report registry retrieved",
  "status": "ok"
}

Delete multiple registries

Request

Definition

DELETE /api/v1/reports/registries

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Request body

{
  "registry_ids": [
    "5fxxx011-xxxx-4c59-xxxx-a31xxx3bxxe5"
  ]
}

Response

Status codes

Status code	Message
200	"Report registries succesfully deleted"
400	"Error deleting report registries"
403	"Forbidden"

Body

{
  "message": "Report registries succesfully deleted",
  "status": "ok"
}