...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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": ""
},
{....}
]
}
} |
Status code: 200
resultCode → SUCCESS
resultMessage → “Reports retrieved successfully”
...
Status | ||||
---|---|---|---|---|
|
...
title | /op/api/v2/report/{{productView}}/{{reportApiReferenceId}} |
---|
URL:
GET - https://{{dpodHostname}}
/op/api/v2/report/{{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
...
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:
Code Block |
---|
curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}} |
APIs List:
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:GET - https:// |
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 |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description | ||||
---|---|---|---|---|---|---|
Successful |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Status code: 200
| Status code: 200 resultCode → SUCCESS resultMessage → |
“Reports retrieved successfully” result → |
list of all reports and their data. For report parameters info click here:Reports REST API - Message Structure |
Status | |
---|---|
|
...
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POSTGET - https:///executeAsync |
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 |
| See roles information here: Role Based Access Control |
Response:
Response Type |
---|
Value |
---|
Example Json
Description |
---|
Required
List<String>
recipients
Map<String, String>
filtersParameters
Successful |
|
|
|
|
|
|
recipients
→ recipients' email address. Array can be sent empty.filtersParameters
→ list of filters. List can be sent empty.
Additional parameter
Available filters:
language | json |
---|
|
|
|
|
|
|
|
|
|
|
|
|
TODO - add all available filters and their description.
Response:
Response Type
Value
Description
Successful
language | json |
---|
|
|
|
|
|
|
|
|
Status code: 200
resultCode → SUCCESS
resultMessage → “Report executed successfully”
result → executionId → the report execution id (integer).
Status | ||||
---|---|---|---|---|
|
Expand | ||||
---|---|---|---|---|
| ||||
URL:GET - https:// | ||||
Parameter | Value | Description | Parameter Type | Data Type |
productView | required | Relevant product view APIC / IDG | path | APIC / IDG |
executionId | required | The report execution ID (can be retrieved from “execute report” api response) | path | ID |
Authentication Type | Required Permissions | More info | ||
Basic Auth |
| See roles information here: Role Based Access Control | ||
Response Type | Value | Description | Successful | |
Code Block | ||||
|
| Status code: 200 resultCode → SUCCESS resultMessage → “Report retrieved successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - https:// |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to execute ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Request:
Type | Parameters | Example Json | Description | |||||
---|---|---|---|---|---|---|---|---|
Required |
|
|
For report parameters info click here:Reports REST API - Message Structure | |||||
Additional parameter | Available filters: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| TODO - add all available filters and their description. |
Response:
Response Type | Value | Description | ||||
---|---|---|---|---|---|---|
Successful |
|
|
| Status code: 200 resultCode → SUCCESS resultMessage → “Report |
executed successfully” result → |
executionId → |
recipients
→
filters
→
executingUserName
→
status
→
requestTimeInMillis
→
executionTimeInMillis
→
completionTimeInMillis
→
Status | ||||
---|---|---|---|---|
|
...
|
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
URL:GET - https:///download |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Relevant product view APIC / IDG | path | APIC / IDG |
executionId | required | The report execution ID (can be retrieved from “execute report” api response) | path | ID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful |
xls file type
|
title | /op/api/v2/report/{{productView}}/{{reportApiReferenceId}}/duplicate |
---|
URL:
POST - https://{{dpodHostname}}
/op/api/v2/report/{{productView}}
/{{reportApiReferenceId}}
/duplicate
Request - None.
Parameters:
Parameter
Value
Description
Parameter Type
Data Type
productView
required
Product view APIC / IDG
path
APIC / IDG
reportApiReferenceId
required
The report apiReferenceId you wish to duplicate ( id can be retrieved from “Retrieved all reports” response)
path
UUID
Authorization:
Authentication Type
Required Permissions
More info
Basic Auth
Edit report
Access permissions for required product related to the report you wish to duplicate
See roles information here: Role Based Access Control
Response:
Response Type
Value
Description
Successful
language | json |
---|
Status | ||||
---|---|---|---|---|
|
Status code: 200 resultCode → SUCCESS resultMessage → “Report duplicated successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure
|
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
URL:GET - https:// |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Relevant product view APIC / IDG | path | APIC / IDG |
executionId | required | The report execution ID (can be retrieved from “execute report” api response) | path | ID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description |
---|---|---|
Successful | xls file type | Status code: 200 |
Status | ||||
---|---|---|---|---|
|
...
Duplicate Report
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - https://reports |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to duplicate ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
|
| See roles information here: Role Based Access Control |
Response:
Response Type |
---|
Value |
---|
Example Json
Description |
---|
Successful |
name
|
description
language | json |
---|
|
String productView
String indexSets
String documentType
String jsonQuery
String jsonParameters
String schedule
List<String>recipients
List<String>adHocFilterTypes
Map<String, String>filtersParameters
String serviceNameFieldOverride
String esHeadersDictionary
|
|
|
|
|
|
|
|
|
recipients
→ recipients' email address. Array can be sent empty.filtersParameters
→ list of filters. List can be sent empty.
Status code: 200 resultCode → SUCCESS resultMessage → “Report duplicated successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
Additional parameter
Available adHocFilterTypes
:
language | json |
---|
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL:POST - https:// |
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 |
| See roles information here: Role Based Access Control |
Request:
Type | Parameters | Example Json | Description | |||||
---|---|---|---|---|---|---|---|---|
Required |
|
|
For report parameters info click here:Reports REST API - Message Structure | |||||
Additional parameter | Available |
| TODO - add all available filters and their description. | |||||
Additional parameter | Available |
| TODO - add all available filters and their description. |
Response:
Response Type | Value | Description | ||||
---|---|---|---|---|---|---|
Successful |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TODO - add all available filters and their description.
Additional parameter
Available filtersParameters
:
language | json |
---|
|
|
TODO - add all available filters and their description.
Response:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report added successfully” result → The report data. For report parameters info click here:Reports REST API - Message Structure |
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
URL:PUT - https:// |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to edit ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Request:
title | /op/api/v2/report/{{productView}}/{{reportApiReferenceId}} |
---|
URL:
PUT - https://{{dpodHostname}}
/op/api/v2/report/{{productView}}
/{{reportApiReferenceId}}
Parameters:
Parameter
Value
Description
Parameter Type
Data Type
productView
required
Product view APIC / IDG
path
APIC / IDG
reportApiReferenceId
required
The report apiReferenceId you wish to edit ( id can be retrieved from “Retrieved all reports” response)
path
UUID
Authorization:
Authentication Type
Required Permissions
More info
Basic Auth
Edit report
Access permissions for product view of new report
See roles information here: Role Based Access Control
Request:
Type | Parameters | Example Json | Description | ||||
---|---|---|---|---|---|---|---|
Required |
|
|
|
|
|
|
|
Status code: 200
resultCode → SUCCESS
resultMessage → “Report added successfully”
result → The report data. For report parameters info click here:Reports REST API - Message StructureStatus | ||||
---|---|---|---|---|
|
Response:
TODO - add all available filters and their description. Additional parameter Available Code Block |
TODO - add all available filters and their description. Response:
|
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
URL:DELETE - https:// |
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
productView | required | Product view APIC / IDG | path | APIC / IDG |
reportApiReferenceId | required | The report apiReferenceId you wish to delete ( id can be retrieved from “Retrieved all reports” response) | path | UUID |
Authorization:
Authentication Type | Required Permissions | More info |
---|---|---|
Basic Auth |
| See roles information here: Role Based Access Control |
Response:
Response Type | Value | Description | |||||
---|---|---|---|---|---|---|---|
Successful |
| Status code: 200 resultCode → SUCCESS resultMessage → “Report |
...
|