GET Support for Endpoint
Endpoint configurations can now be fully managed through APIs.
You can:
- View, update, and create endpoints.
- Fetch supporting metadata to simplify setup and ensure compliance across environments.
- Standardize endpoint management when working with multiple facilities, regions, or external systems.
ENTITY: ENDPOINT
The endpoint entity represents a connection configuration to an external system (e.g., S3 bucket, GCP object store, or integration). Endpoints include details such as protocol, authentication type, storage provider, and integration metadata.
ENDPOINT MANAGEMENT
Method | URL | Detailed Description |
---|---|---|
GET | .../wms/lgfapi/v10/entity/endpoint/ |
Retrieves a paginated list of all configured endpoints. Useful for auditing and monitoring. |
GET |
|
Retrieves details of a specific endpoint by ID. Sensitive fields (keys, passwords) are excluded. |
HEAD |
|
Quickly checks if any endpoints exist without fetching details. Useful for lightweight validation in automation. |
HEAD |
|
Validates the existence of an endpoint by ID. Helps confirm availability before making updates. |
PATCH |
|
Updates an existing endpoint configuration. Supports incremental, version-controlled changes. |
POST |
|
Creates a new endpoint with protocol, authentication, and provider details. |
SUPPORTING METADATA
Method |
URL |
Detailed Description |
GET |
|
Retrieves supported authentication methods (e.g., Access Key, OAuth). |
GET |
|
Retrieves supported object store providers (AWS S3, GCP, OCI, Azure). |
GET |
|
Retrieves supported integration names for endpoint association. |
For detailed API documentation, refer to the WMS REST API Guide.
Steps to Enable
You don't need to do anything to enable this feature.