Public API Metadata

The /.well-known endpoint is a public metadata endpoint designed to help clients, SDKs, and integrations automatically discover important configuration information about your API.

By accessing this endpoint, developers and tools can programmatically retrieve:

• The base URL for API requests (api_base_url)

• The supported API versions (supported_api_versions) and default version (default_api_version)

• The current API release version (version)

• The environment (e.g., dev, staging, prod)

• A public key or certificate for secure communications (pub_key)

• A list of available API endpoints and their HTTP methods (endpoints)

This eliminates the need for manual configuration or hardcoding these values into client applications. This endpoint is publicly accessible and requires no authentication.

Use Case Example: When a new SDK initializes, it can first call /.well-known to learn the API base URL, supported versions, and endpoints, ensuring that all requests are correctly configured without requiring manual updates in the code.

Endpoint

• Method: GET

• URL: /api/v4/.well-known

• Description: Returns static or generated JSON with environment, version, and endpoint details.

Example responses

Response (200)

{
  "api_base_url": "http://api.licensespring.com/api/v4",
  "environment": "dev",
  "supported_api_versions": ["v4"],
  "default_api_version": "v4",
  "version": "4.1.34",
  "timestamp": "2025-10-28T10:32:21.580Z",
  "pub_key": "-----BEGIN CERTIFICATE-----\nMIIFrjCCA5YCCQDXhLQ....0ExGTAXBgNVBAgT-----END CERTIFICATE-----",
  "endpoints": [
    {"method": "GET", "url": "/api/v4/.well-known"},
    {"method": "GET", "url": "/api/v4/trial_key/"},
    {"method": "POST", "url": "/api/v4/activate_license/"},
    {"method": "POST", "url": "/api/v4/activate_bundle/"},
    {"method": "POST", "url": "/api/v4/activate_offline/"},
    {"method": "POST", "url": "/api/v4/activate_bundle_offline/"},
    {"method": "POST", "url": "/api/v4/deactivate_license/"},
    {"method": "POST", "url": "/api/v4/deactivate_offline/"},
    {"method": "POST", "url": "/api/v4/deactivate_bundle/"},
    {"method": "POST", "url": "/api/v4/deactivate_bundle_offline/"},
    {"method": "GET", "url": "/api/v4/check_license/"},
    {"method": "GET", "url": "/api/v4/check_license_feature/"},
    {"method": "POST", "url": "/api/v4/add_consumption/"},
    {"method": "POST", "url": "/api/v4/add_feature_consumption/"},
    {"method": "GET", "url": "/api/v4/get_device_variables/"},
    {"method": "POST", "url": "/api/v4/track_device_variables/"},
    {"method": "GET", "url": "/api/v4/versions/"},
    {"method": "GET", "url": "/api/v4/installation_file/"},
    {"method": "POST", "url": "/api/v4/floating/borrow/"},
    {"method": "POST", "url": "/api/v4/floating/release/"},
    {"method": "POST", "url": "/api/v4/floating/feature_release/"},
    {"method": "POST", "url": "/api/v4/change_password/"},
    {"method": "GET", "url": "/api/v4/customer_license_users/"},
    {"method": "GET", "url": "/api/v4/sso_url/"},
    {"method": "GET", "url": "/api/v4/products/"},
    {"method": "GET", "url": "/api/v4/product_details/"},
    {"method": "GET", "url": "/api/v4/user_licenses/"},
    {"method": "GET", "url": "/api/v4/device_licenses/"},
    {"method": "GET", "url": "/api/v4/oauth_url/"},
    {"method": "GET", "url": "/api/v4/check_bundle/"},
    {"method": "POST", "url": "/api/v4/webhook/order/"},
    {"method": "GET", "url": "/api/v4/webhook/license/"}
  ]
}

Response fields

• api_base_url (string, optional) — Base URL for the API.

• supported_api_versions (array, optional) — List of API versions supported.

• default_api_version (string, optional) — Default API version to use.

• version (string, optional) — Current API release version.

• environment (string, optional) — Current environment (e.g., dev, staging, prod).

• timestamp (string, optional) — UTC timestamp when the response was generated (ISO-8601 UTC).

• pub_key (string, optional) — Public certificate/key for API communication.

• endpoints (array, optional) — List of all available API endpoints with method and path.

Provides public configuration metadata so clients and SDKs can automatically discover API details like base URL, supported versions, and endpoints.