Download OpenAPI specification:Download
Successful response
Unauthorized
Internal server error
Production server.
{- "data_types": [
- {
- "id": 2,
- "name": "Card number",
- "sensitivity": "High"
}
], - "total": 0
}
Successful response
Unauthorized
Internal server error
Production server.
{- "clusters": [
- {
- "id": 2,
- "name": "private-cloud/sg-pc-6g"
}
], - "total": 0
}
limit | integer <int> >= 1 Default: 100 Example: limit=25 Number of entries to show. |
offset | integer <int> >= 0 Default: 0 Example: offset=10 Number of entries to skip. |
cluster_id | integer <int64> >= 1 Example: cluster_id=150 Cluster ID. |
Successful response
Invalid request
Unauthorized
Internal server error
Production server.
{- "assets": [
- {
- "id": 0,
- "name": "Some asset name",
- "description": "string",
- "owner": "John Doe",
- "kind": "k8s_workload",
- "info": {
- "cluster_id": 0,
- "is_external": true,
- "type": "endusers",
- "namespace": "booking-api",
- "k8s_types": [
- "LoadBalancer"
], - "labels": [
- {
- "key": "app.kubernetes.io/name",
- "value": "nginx"
}
]
}, - "data_types": [
- 0
], - "first_seen_at": 1638267989332,
- "last_seen_at": 1638267989332
}
], - "total": 0
}
id required | integer <int64> >= 0 Example: 150 ID. |
Successful response
Unauthorized
Not found
Internal server error
Production server.
{- "id": 0,
- "name": "Some asset name",
- "description": "string",
- "owner": "John Doe",
- "kind": "k8s_workload",
- "info": {
- "cluster_id": 0,
- "is_external": true,
- "type": "endusers",
- "namespace": "booking-api",
- "k8s_types": [
- "LoadBalancer"
], - "labels": [
- {
- "key": "app.kubernetes.io/name",
- "value": "nginx"
}
]
}, - "data_types": [
- 0
], - "first_seen_at": 1638267989332,
- "last_seen_at": 1638267989332
}
id required | integer <int64> >= 0 Example: 150 ID. |
limit | integer <int> >= 1 Default: 100 Example: limit=25 Number of entries to show. |
offset | integer <int> >= 0 Default: 0 Example: offset=10 Number of entries to skip. |
Successful response
Invalid request
Unauthorized
Internal server error
Production server.
{- "data_flows": [
- {
- "asset_id": 0,
- "counterparty_asset_id": 0,
- "to_counterparty_data_types": [
- 0
], - "from_counterparty_data_types": [
- 0
], - "data_streams": [
- {
- "requester_asset_id": 0,
- "responder_asset_id": 0,
- "endpoint_id": 0,
- "request_data_types": [
- 0
], - "response_data_types": [
- 0
], - "last_seen_at": 1638267989332
}
]
}
], - "total": 0
}
id required | integer <int64> >= 0 Example: 150 ID. |
Successful response
Unauthorized
Not found
Internal server error
Production server.
{- "id": 0,
- "asset_id": 0,
- "hostname": "api.example.com",
- "method": "GET",
- "url": "/api/v1/user/[num]",
- "request_data_types": [
- 0
], - "response_data_types": [
- 0
], - "request_data_fields": [
- {
- "json_path": "users[0].profile.email",
- "data_type": 0,
- "masked_value": "*****@***.**"
}
], - "response_data_fields": [
- {
- "json_path": "users[0].profile.email",
- "data_type": 0,
- "masked_value": "*****@***.**"
}
], - "last_seen_at": 1638267989332
}
id required | integer <int64> >= 0 Example: 150 ID. |
limit | integer <int> >= 1 Default: 100 Example: limit=25 Number of entries to show. |
offset | integer <int> >= 0 Default: 0 Example: offset=10 Number of entries to skip. |
Successful response
Invalid request
Unauthorized
Internal server error
Production server.
{- "endpoints": [
- {
- "id": 0,
- "asset_id": 0,
- "hostname": "api.example.com",
- "method": "GET",
- "url": "/api/v1/user/[num]",
- "request_data_types": [
- 0
], - "response_data_types": [
- 0
], - "request_data_fields": [
- {
- "json_path": "users[0].profile.email",
- "data_type": 0,
- "masked_value": "*****@***.**"
}
], - "response_data_fields": [
- {
- "json_path": "users[0].profile.email",
- "data_type": 0,
- "masked_value": "*****@***.**"
}
], - "last_seen_at": 1638267989332
}
], - "total": 0
}