Public API Metadata

api well known endpoint 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 { "name" "/api/v4/ well known", "method" "get", "url" "/api/v4/ well known", "description" "returns static or generated json with environment, version, and endpoint details ", "tab" "examples", "examples" { "languages" \[ { "id" "lgiqyyjqovvkdptsins5w", "language" "none", "code" " none ", "customlabel" "" } ], "selectedlanguageid" "lgiqyyjqovvkdptsins5w" }, "results" { "languages" \[ { "id" "ivlryac4tqroakfa6ly80", "language" "200", "code" "{\n \\"api base url\\" \\"http //api dev licensespring com/api/v4\\",\n \\"environment\\" \\"dev\\",\n \\"supported api versions\\" \[\\"v4\\"],\n \\"default api version\\" \\"v4\\",\n \\"version\\" \\"4 1 34\\",\n \\"timestamp\\" \\"2025 10 28t10 32 21 580z\\",\n \\"pub key\\" \\" begin certificate \\\nmiifrjcca5yccqdxhlqtq1vvlzanbgkqhkig9w0baqsfadcbmdelmakga1uebhmc\\\nq0exgtaxbgnvbagt end certificate \\",\n \\"endpoints\\" \[\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/ well known\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/trial key/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/activate license/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/activate bundle/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/activate offline/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/activate bundle offline/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/deactivate license/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/deactivate offline/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/deactivate bundle/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/deactivate bundle offline/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/check license/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/check license feature/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/add consumption/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/add feature consumption/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/get device variables/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/track device variables/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/versions/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/installation file/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/floating/borrow/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/floating/release/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/floating/feature release/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/change password/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/customer license users/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/sso url/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/products/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/product details/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/user licenses/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/device licenses/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/oauth url/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/check bundle/\\"},\n {\\"method\\" \\"post\\", \\"url\\" \\"/api/v4/webhook/order/\\"},\n {\\"method\\" \\"get\\", \\"url\\" \\"/api/v4/webhook/license/\\"}\n ]\n}\n\n", "customlabel" "" }, { "id" "5v8xkuyoex5twdfwfybbl", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "selectedlanguageid" "ivlryac4tqroakfa6ly80" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "api base url", "kind" "optional", "type" "string", "description" "base url for the api \n" }, { "name" "supported api versions", "kind" "optional", "type" "array", "description" "list of api versions supported ", "children" \[] }, { "name" "default api version", "kind" "optional", "type" "string", "description" "default api version to use ", "children" \[] }, { "name" "version", "kind" "optional", "type" "string", "description" "current api release version ", "children" \[] }, { "name" "environment", "kind" "optional", "type" "string", "description" "current environment (e g , dev, staging, prod) \n", "children" \[] }, { "name" "timestamp", "kind" "optional", "type" "string", "description" "utc timestamp when the response was generated string (iso 8601 utc)\n", "children" \[] }, { "name" "pub key", "kind" "optional", "type" "string", "description" "public certificate/key for api communication ", "children" \[] }, { "name" "endpoints", "kind" "optional", "type" "array", "description" "list of all available api endpoints with method and path ", "children" \[] } ] } provides public configuration metadata so clients and sdks can automatically discover api details like base url, supported versions, and endpoints