...
Authentication: Basic authentication
Authorization: Any user allowed using Reports, see:
Code Block |
---|
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}} |
Status | ||||
---|---|---|---|---|
|
...
title | /op/api/v2/reports/{{productView}} |
---|
URL:
GET - https://{{dpodHostname}}
/op/api/v2/reports/{{productView}}
Request - None.
Parameters:
...
Parameter
...
Value
...
Description
...
Parameter Type
...
Data Type
...
productView
...
required
...
Product view APIC / IDG
...
path
...
APIC / IDG
Authorization:
...
Authentication Type
...
Required Permissions
...
More info
...
Basic Auth
...
View or Edit report
Access permissions for required product
...
See roles information here: Role Based Access Control
Response:
...
Response Type
...
Value
...
Description
...
Successful
...
Code Block |
---|
{
"resultCode": "SUCCESS",
"resultMessage": "Reports retrieved successfully",
"result": {
"reports": [{
"name": "API Latency Report",
"description": "API Latency",
"productView": "APIC",
"apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856",
"indexSets": "apic-log",
"documentType": "APIC_LOGICAL_TRANS",
"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }",
"schedule": "",
"recipients": [],
"adHocFilterTypes": ["TIME", "DEVICE",....],
"filtersParameters": { "timeRangeType": "recent",.....},
"lastUpdateTimeInMillis": 1646655197926,
"lastUpdateUserName": "admin",
"esHeadersDictionary": ""
}
]
}
} |
resultCode → SUCCESS
resultMessage → “Reports retrieved successfully”
...
Status | ||||
---|---|---|---|---|
|
...
title | /op/api/v2/report/{{productView}}/{{reportApiReferenceId}} |
---|
URL:
GET - https://{{dpodHostname}}
/op/api/v2/reports/{{productView}}
/{{reportApiReferenceId}}
Request - None.
Parameters:
...
Parameter
...
Value
...
Description
...
Parameter Type
...
Data Type
...
productView
...
required
...
Product view APIC / IDG
...
path
...
APIC / IDG
...
reportApiReferenceId
...
required
...
The report apiReferenceId (can be retrieved from “Retrieved all reports” response)
...
path
...
UUID
Authorization:
...
Authentication Type
...
Required Permissions
...
More info
...
Basic Auth
...
View or Edit report
Access permissions for required product related to the report
...
See roles information here: Role Based Access Control
Response:
...
Response Type
...
Value
...
Description
...
Successful
...
Code Block |
---|
{
"resultCode": "SUCCESS",
"resultMessage": "Report retrieved successfully",
"result": {
"name": "API Latency Report",
"description": "API Latency",
"productView": "APIC",
"apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856",
"indexSets": "apic-log",
"documentType": "APIC_LOGICAL_TRANS",
"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }",
"schedule": "",
"recipients": [],
"adHocFilterTypes": ["TIME", "DEVICE",....],
"filtersParameters": { "timeRangeType": "recent",.....},
"lastUpdateTimeInMillis": 1644768927839,
"lastUpdateUserName": "Installer",
"esHeadersDictionary": ""
}
} |
resultCode → SUCCESS
resultMessage → “Report retrieved successfully”
...
Get / Update / Execute / Delete reports
Authentication: Basic authentication
Authorization: Any user allowed using Reports, see:
Code Block |
---|
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}} |
Status | ||||
---|---|---|---|---|
|
...
title | /op/api/v2/reports/{{productView}} |
---|
URL:
GET - https://{{dpodHostname}}
/op/api/v2/reports/{{productView}}
Parameters:
...
Parameter
...
Value
...
Description
...
Parameter Type
...
Data Type
...
productView
...
required
...
Product view APIC / IDG
...
path
...
APIC / IDG
Authorization:
...
Authentication Type
...
Required Permissions
...
More info
...
Basic Auth
...
View or Edit report
Access permissions for required product
...
See roles information here: Role Based Access Control
Response:
...
Response Type
...
Value
...
Description
...
Successful
...
Code Block |
---|
{
"resultCode": "SUCCESS",
"resultMessage": "Reports retrieved successfully",
"result": {
"reports": [{
"name": "API Latency Report",
"description": "API Latency",
"productView": "APIC",
"apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856",
"indexSets": "apic-log",
"documentType": "APIC_LOGICAL_TRANS",
"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }",
"schedule": "",
"recipients": [],
"adHocFilterTypes": ["TIME", "DEVICE",....],
"filtersParameters": { "timeRangeType": "recent",.....},
"lastUpdateTimeInMillis": 1646655197926,
"lastUpdateUserName": "admin",
"esHeadersDictionary": ""
}
]
}
} |
resultCode → SUCCESS
resultMessage → “Reports retrived successfully”
...
Available report actions via APIs
Get / Create / Update / Execute / Delete reports
Authorization:
Authentication: Basic authentication
Roles: it is recommended to read Role Based Access Control page for understanding build-in and custom roles permissions.
From CLI (example):
Code Block |
---|
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}} |
...
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
URL:GET - https:// |
Name | Is required | Description | Parameter Type | Data options |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Reports retrieved successfully” |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
URL:GET - https:// |
Name | Is required | Description | Parameter Type | Data options |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
reportApiReferenceId | True | The report apiReferenceId (can be retrieved from “Retrieved all reports” response) | String |
|
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report retrieved successfully” |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - https:// |
Name | Is required | Description | Parameter Type | Data options |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
reportApiReferenceId | True | The report apiReferenceId you wish to execute ( id can be retrieved from “Retrieved all reports” response) | String |
|
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Request body:
Type | Parameters | Example Json | Description | |||||
---|---|---|---|---|---|---|---|---|
Required |
|
|
| |||||
Additional parameter | Available filters: |
|
|
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report executed successfully” result → executionId → The report execution id (integer). |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
URL:GET - https:// |
Name | Is required | Description | Parameter Type | Data options |
---|---|---|---|---|
productView | True | Relevant product view APIC / IDG | String |
|
executionId | True | The report execution ID (can be retrieved from “execute report” api response) | String | The report Id |
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report execution retrieved successfully” result →
|
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
URL:GET - https:// |
Name | Is required | Description | Parameter Type | Data options |
---|---|---|---|---|
productView | True | Relevant product view APIC / IDG | String |
|
executionId | True | The report execution ID (can be retrieved from “execute report” api response) | String | The report Id |
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful | xls file type | Status code: 200 |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
URL:POST - https:// |
Name | Is Required | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
reportApiReferenceId | True | The report apiReferenceId you wish to duplicate ( id can be retrieved from “Retrieved all reports” response) | String | ‘apiReferenceId’ value from the original report |
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report duplicated successfully” |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - https:// |
Name | Is required | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Request body:
Type | Parameters | Example Json | Description | |||||
---|---|---|---|---|---|---|---|---|
Required |
|
|
| |||||
Additional parameter | Available |
| ||||||
Additional parameter | Available |
|
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report added successfully” |
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:PUT - https:// |
Name | Is required | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
reportApiReferenceId | True | The report apiReferenceId you wish to edit ( id can be retrieved from “Retrieved all reports” response) | String | ‘apiReferenceId’ of the report you want to edit |
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Request:
Type | Parameters | Example Json | Description | |||||
---|---|---|---|---|---|---|---|---|
Required |
|
|
| |||||
Additional parameter | Available |
| ||||||
Additional parameter | Available |
|
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report updated successfully” |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
URL:DELETE - https:// |
Name | Is required | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | True | Product view APIC / IDG | String |
|
reportApiReferenceId | True | The report apiReferenceId you wish to delete ( id can be retrieved from “Retrieved all reports” response) | String | ‘apiReferenceId’ of the report to delete |
Authorization:
Required Permissions | More info |
---|---|
| See roles information here: Role Based Access Control |
Response:
Response Type | Example value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report deleted successfully” |