ApiCollection Class

An API collection as represented by Microsoft Defender for APIs.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

ApiCollection(**kwargs: Any)

Variables

Name Description
id
str

Resource Id.

name
str

Resource name.

type
str

Resource type.

provisioning_state

Gets the provisioning state of the API collection. Known values are: "Succeeded", "Failed", "Canceled", and "InProgress".

display_name
str

The display name of the API collection.

discovered_via
str

The resource Id of the resource from where this API collection was discovered.

base_url
str

The base URI for this API collection. All endpoints of this API collection extend this base URI.

number_of_api_endpoints
int

The number of API endpoints discovered in this API collection.

number_of_inactive_api_endpoints
int

The number of API endpoints in this API collection that have not received any API traffic in the last 30 days.

number_of_unauthenticated_api_endpoints
int

The number of API endpoints in this API collection that are unauthenticated.

number_of_external_api_endpoints
int

The number of API endpoints in this API collection for which API traffic from the internet was observed.

number_of_api_endpoints_with_sensitive_data_exposed
int

The number of API endpoints in this API collection which are exposing sensitive data in their requests and/or responses.

sensitivity_label
str

The highest priority sensitivity label from Microsoft Purview in this API collection.