Skip to content

Version ​

Interface Description ​

Read the product version and Developer OpenAPI version for client compatibility checks.

Endpoint ​

FieldValue
MethodGET
Path/openapi/v2/version
Operation IDgetDeveloperOpenApiVersion
AuthenticationBearer OpenAPI key

Parameters ​

This operation has no path or query parameters.

Request Body ​

This operation has no request body.

Request Example ​

bash
curl -X GET "https://openapi.example.com/openapi/v2/version" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses ​

200 ​

Current product and Developer OpenAPI versions.

FieldRequiredTypeDescription
productYes"focowiki"Product identifier.
versionYesstringCurrent product release version.
apiVersionYes"v2"Developer OpenAPI contract version.

Success Response Example ​

json
{
  "product": "focowiki",
  "version": "0.7.47",
  "apiVersion": "v2"
}

Error Codes ​

The table below lists every error response documented for this operation.

HTTP StatusError CodeExplanation
401UNAUTHORIZEDThe Bearer API key is missing, malformed, unknown, revoked, or deleted.
429RATE_LIMITEDThe request exceeded the configured rate limits.
500INTERNAL_ERRORThe API encountered an internal error.
503DATABASE_REPOSITORY_UNAVAILABLEThe data required by this operation is temporarily unavailable.

Next Steps ​