🔐 Api API
Resource cataloging with automatic classification and security profiling. Organizational hierarchies segment access by function or protection policy.
- Category: Security
- Complexity: advanced
- Paths: 45 | Schemas: 279
- Tier: Advanced
- Related domains:
virtual,network_security
Use Cases
Section titled “Use Cases”- Discover and catalog APIs
- Test API security and behavior
- Manage API credentials
- Define API groups and testing policies
Primary Resources
Section titled “Primary Resources”- api_definition: API schema definition for discovery and protection
- api_endpoint: Individual API endpoint configuration and protection
- api_rate_limit: API rate limiting configuration for traffic control
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/config/namespaces/{metadata.namespace}/api_crawlers | Create API Crawler. |
| PUT | /api/config/namespaces/{metadata.namespace}/api_crawlers/{metadata.name} | Replace API crawler. |
| GET | /api/config/namespaces/{namespace}/api_crawlers | List API Crawler. |
| GET | /api/config/namespaces/{namespace}/api_crawlers/{name} | GET API crawler. |
| DELETE | /api/config/namespaces/{namespace}/api_crawlers/{name} | DELETE API Crawler. |
| POST | /api/config/namespaces/{metadata.namespace}/api_definitions | Create API Definition. |
| PUT | /api/config/namespaces/{metadata.namespace}/api_definitions/{metadata.name} | Replace API Definition. |
| GET | /api/config/namespaces/{namespace}/api_definitions | List API Definition. |
| GET | /api/config/namespaces/{namespace}/api_definitions/{name} | GET API Definition. |
| DELETE | /api/config/namespaces/{namespace}/api_definitions/{name} | DELETE API Definition. |
| GET | /api/config/namespaces/{namespace}/api_definitions/{name}/loadbalancers | GET Referencing Loadbalancers. |
| POST | /api/config/namespaces/{namespace}/api_definitions/{name}/mark_as_non_api | Mark As Non-API. |
| POST | /api/config/namespaces/{namespace}/api_definitions/{name}/move_to_inventory | Move To API Inventory. |
| POST | /api/config/namespaces/{namespace}/api_definitions/{name}/remove_from_inventory | Remove From API Inventory. |
| POST | /api/config/namespaces/{namespace}/api_definitions/{name}/unmark_as_non_api | Unmark As Non-API. |
| GET | /api/config/namespaces/{namespace}/api_definitions_without_shared | List Available API Definitions. |
| POST | /api/config/namespaces/{metadata.namespace}/api_discoverys | Create API Discovery. |
| PUT | /api/config/namespaces/{metadata.namespace}/api_discoverys/{metadata.name} | Replace API Discovery. |
| GET | /api/config/namespaces/{namespace}/api_discoverys | List API Discovery. |
| GET | /api/config/namespaces/{namespace}/api_discoverys/{name} | GET API Discovery. |
| DELETE | /api/config/namespaces/{namespace}/api_discoverys/{name} | DELETE API Discovery. |
| GET | /api/web/namespaces/{namespace}/api_groups | List API Group. |
| GET | /api/web/namespaces/{namespace}/api_groups/{name} | GET API Group. |
| GET | /api/web/namespaces/{namespace}/api_group_elements | List API Group Element. |
| GET | /api/web/namespaces/{namespace}/api_group_elements/{name} | GET API Group Element. |
| POST | /api/config/namespaces/{metadata.namespace}/api_testings | Create API Testing. |
| PUT | /api/config/namespaces/{metadata.namespace}/api_testings/{metadata.name} | Replace API testing. |
| GET | /api/config/namespaces/{namespace}/api_testings | List API Testing. |
| GET | /api/config/namespaces/{namespace}/api_testings/{name} | GET API testing. |
| DELETE | /api/config/namespaces/{namespace}/api_testings/{name} | DELETE API Testing. |
| POST | /api/config/namespaces/{metadata.namespace}/app_api_groups | Create API Group. |
| PUT | /api/config/namespaces/{metadata.namespace}/app_api_groups/{metadata.name} | Replace API Group. |
| GET | /api/config/namespaces/{namespace}/app_api_groups | List App API Group. |
| POST | /api/ml/data/namespaces/{namespace}/app_api_groups/evaluate | Evaluate API Group. |
| POST | /api/ml/data/namespaces/{namespace}/app_api_groups/stats | Evaluate API Group. |
| GET | /api/config/namespaces/{namespace}/app_api_groups/{name} | GET API Group. |
| DELETE | /api/config/namespaces/{namespace}/app_api_groups/{name} | DELETE App API Group. |
| POST | /api/config/namespaces/{namespace}/api_sec/rule_suggestion/api_endpoint_protection | Suggest API endpoint protection rule. |
| POST | /api/config/namespaces/{namespace}/api_sec/rule_suggestion/data_exposure | Suggest sensitive data rule. |
| POST | /api/config/namespaces/{namespace}/api_sec/rule_suggestion/oas_validation | Suggest Open API specification validation rule. |
| POST | /api/config/namespaces/{namespace}/api_sec/rule_suggestion/rate_limit | Suggest rate limit rule. |
| POST | /api/config/namespaces/{metadata.namespace}/code_base_integrations | CREATE Code Base Integration. |
| PUT | /api/config/namespaces/{metadata.namespace}/code_base_integrations/{metadata.name} | Replace Code Base Integration. |
| GET | /api/config/namespaces/{namespace}/code_base_integrations | List Code Base Integration. |
| GET | /api/config/namespaces/{namespace}/code_base_integrations/{name} | GET Code Base Integration. |
| DELETE | /api/config/namespaces/{namespace}/code_base_integrations/{name} | DELETE Code Base Integration. |
| POST | /api/config/namespaces/{metadata.namespace}/discoverys | Create Discovery. |
| PUT | /api/config/namespaces/{metadata.namespace}/discoverys/{metadata.name} | Replace Discovery. |
| POST | /api/config/namespaces/{namespace}/discovery/{name}/download_certificates | Download Certificates. |
| GET | /api/config/namespaces/{namespace}/discoverys | List Discovery. |
| GET | /api/config/namespaces/{namespace}/discoverys/{name} | GET Discovery. |
| DELETE | /api/config/namespaces/{namespace}/discoverys/{name} | DELETE Discovery. |