Reports

Overview

Note: Reports is an extension and needs to be enabled before it can be used. If Designate returns a 404 error, ensure that the following line has been added to the designate.conf file:

enabled_extensions_v1 = reports, ...

Reports about things in the system

Get all tenants

GET /reports/tenants

Fetch all tenants

Example request:

GET /reports/tenants HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "tenants": [{
      "domain_count": 2,
      "id": "71ee6d049a49435c8f7dd002cfe08d96"
  }]
}

Form Parameters:  

• tenants – List of tenants

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Access Denied

Report tenant resources

GET /reports/tenants/(tenant_id)

Report tenant resources

Example request:

GET /reports/tenants/3d8391080d4a4ec4b3eadf18e6b1539a HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "domain_count": 0,
    "domains": [],
    "id": "3d8391080d4a4ec4b3eadf18e6b1539a"
}

Parameters:

• tenant_id (string) – Tenant Id to get reports for

Form Parameters:  

• domain_count – integer
• domains – Server hostname
• id – Tenant Id

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Access Denied

Report resource counts

GET /reports/counts

Report resource counts

Example request:

GET /reports/counts HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "domains": 0,
    "records": 0,
    "tenants": 0
}

Form Parameters:  

• domains – Domains count
• records – Records count
• tenants – Tenants count

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Access Denied

Report tenant counts

GET /reports/counts/tenants

Report tenant counts

Example request:

GET /reports/counts/tenants HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "tenants": 0
}

Form Parameters:  

• tenants – Tenants count

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Access Denied

Report domain counts

GET /reports/counts/domains

Report domain counts

Example request:

GET /reports/counts/domains HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "domains": 0
}

Form Parameters:  

• domains – Domains count

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Access Denied

Report record counts

GET /reports/counts/records

Report record counts

Example request:

GET /reports/counts/records HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "records": 0
}

Form Parameters:  

• records – Records count

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Access Denied