API Endpoint

Type: Information Object

Status: Planned
Industry Sector: Information Technology
Sensitivity Level: Internal
Personal Information: No PII

Description:
Published interface endpoint exposed by a technology product, platform or integration service.

Accessed by Application(s):

• API Management Platform
• Professional Services Automation Application

 Yes

Attributes

Order	Name	Description	Type	Cardinality	Example value
1	API Endpoint ID	Unique identifier for the API endpoint	GUID	Mandatory
2	API Name	Name of the API or interface	String	Mandatory	Billing API
3	Status	Current lifecycle status of the endpoint	Enumeration	Mandatory	Published
4	Rate Limit	Rate limit applied to endpoint consumption	String	Optional	1000 requests/minute
5	Owning Product	Product or platform that owns the endpoint	Reference	Mandatory
6	Endpoint Path	Path or address of the endpoint	String	Mandatory	/v1/subscriptions
7	HTTP Method	HTTP method or interaction style used by the endpoint	Enumeration	Optional	GET
8	Authentication Scheme	Authentication scheme required by the endpoint	String	Mandatory	OAuth2
9	Version	Published version of the API endpoint	String	Mandatory	V1

 Yes
 
 Planned
 No PII
 Internal
 Information Technology
 Published interface endpoint exposed by a technology product, platform or integration service.

✏️ Edit