Standards, Conventions, and Versioning
Standards and Conventions
Vaultody adheres to the OpenAPI 3.0 standard for API documentation. All endpoints are RESTful and follow these conventions:
- URI Structure:
https://rest.vaultody.com/{product-name}/
- URI Naming:
- Lowercase letters with spinal-case for path parameters (e.g.,
/vaults/
) - CamelCase for query parameters and variables (e.g.,
?offset=10&limit=0
)
- Lowercase letters with spinal-case for path parameters (e.g.,
- HTTPS Only: All endpoints require HTTPS; HTTP is not supported.
- URI Length: Maximum of 2000 characters, including punctuation.
Request and Response Standards
-
Requests:
- Must be sent via HTTPS to
rest.vaultody.com
- Headers should include
Content-Type: application/json
- Custom attributes prefixed with
x-
(e.g.,x-api-key
) - Public attributes in camelCase
- CORS is enabled, but direct API requests from web applications are discouraged as policies may change.
- Must be sent via HTTPS to
-
Responses:
- Consistent structure with
apiVersion
,requestId
, anddata
fields.
- Consistent structure with
Versioning
Vaultody generates new API versions for backward-incompatible changes. Versions are date-titled, with stable versions marked accordingly. You can select specific API versions and API endpoint to which the API key has access via dashboard.
Was this page helpful?
Yes
No
Loading...