> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a vehicle pre-allocation > Create a pre-allocation (planned reservation) for a vehicle. Pre-allocations retain no history and can be listed, deleted, or converted into an allocation. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/vehicles/{vehicle_id}/pre-allocations openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/vehicles/{vehicle_id}/pre-allocations: post: tags: - Vehicles summary: Create a vehicle pre-allocation description: >- Create a pre-allocation (planned reservation) for a vehicle. Pre-allocations retain no history and can be listed, deleted, or converted into an allocation. operationId: CreateVehiclePreAllocation parameters: - $ref: '#/components/parameters/vehicle_id' requestBody: $ref: '#/components/requestBodies/CreateVehiclePreAllocation' responses: '201': $ref: '#/components/responses/GetVehiclePreAllocation' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - Cookie: [] - OAuth2: [] components: parameters: vehicle_id: name: vehicle_id in: path required: true description: The unique identifier for the vehicle. schema: type: string format: uuid example: d123e456-f789-4abc-b012-3456789abcde requestBodies: CreateVehiclePreAllocation: required: true description: Create a pre-allocation (planned reservation) for a vehicle. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type - attributes properties: type: type: string const: vehicle-pre-allocations attributes: $ref: '#/components/schemas/VehiclePreAllocationAttributes' responses: GetVehiclePreAllocation: description: A vehicle pre-allocation. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/VehiclePreAllocation' included: $ref: '#/components/schemas/VehiclePreAllocationIncludes' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 NotFound: description: The requested resource could not be found headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f status: '404' title: Resource not found detail: The requested resource could not be found or does not exist. code: NOT_FOUND.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. schemas: VehiclePreAllocationAttributes: type: object description: >- Attributes for a vehicle pre-allocation (a planned, deletable reservation). required: - target_type - target_id properties: target_type: type: string description: The kind of target the vehicle is pre-allocated to. enum: - person - scheme - work-order - location target_id: type: string format: uuid description: The identifier of the pre-allocation target. starts_at: type: - string - 'null' format: date-time description: When the pre-allocation is expected to take effect. VehiclePreAllocation: type: object description: A planned (pre-)allocation reservation for a vehicle. required: - id - type - attributes properties: id: type: string format: uuid description: The unique identifier of the pre-allocation. type: type: string const: vehicle-pre-allocations attributes: $ref: '#/components/schemas/VehiclePreAllocationAttributes' relationships: $ref: '#/components/schemas/VehiclePreAllocationRelationships' VehiclePreAllocationIncludes: type: array description: >- Related resources that can be included when a vehicle pre-allocation is returned. items: discriminator: propertyName: type mapping: vehicles: $ref: '#/components/schemas/Vehicle' oneOf: - $ref: '#/components/schemas/Vehicle' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. type: string examples: - AUTH.001 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include required: - id - status - title VehiclePreAllocationRelationships: type: object description: Relationships for a vehicle pre-allocation required: - vehicle properties: vehicle: type: object required: - data properties: data: $ref: '#/components/schemas/VehicleRelationship' Vehicle: type: object description: A vehicle required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the vehicle. type: type: string const: vehicles attributes: $ref: '#/components/schemas/VehicleAttributes' meta: $ref: '#/components/schemas/VehicleMeta' relationships: $ref: '#/components/schemas/VehicleRelationships' VehicleRelationship: type: object description: Represents a relationship to a vehicle required: - id - type properties: id: type: string format: uuid description: The unique identifier of the vehicle type: type: string const: vehicles VehicleAttributes: type: object description: Attributes for a vehicle required: - registration properties: vin: type: - string - 'null' description: The vehicle identification number. registration: type: string description: >- The vehicle's registration number (VRM). Stored uppercase with spaces stripped. examples: - BX10GKJ description: type: - string - 'null' description: A free-text description of the vehicle. colour: type: - string - 'null' description: The vehicle's colour. status: type: - string - 'null' description: >- The vehicle's status. A free-form string (e.g. active, off-road, retired, sorn). When the vehicle is SORN according to DVLA the status is automatically set to `sorn`. VehicleMeta: type: object description: > Metadata for a vehicle. Includes timestamps, derived counts, the rolled-up MOT/tax/SORN status from DVLA, the most recent inspection and inventory check references, and the full DVLA payload. required: - created_at - updated_at properties: created_at: type: string format: date-time updated_at: type: string format: date-time sorn: type: boolean description: Whether the vehicle is SORN according to DVLA. has_recall: type: boolean description: Whether DVLA reports an outstanding recall. last_odometer_reading: type: - integer - 'null' description: The most recent odometer reading taken from MOT records. counts: type: object properties: equipment: type: integer description: Number of equipment items currently assigned. mot: type: object description: Rolled-up MOT status. properties: is_valid: type: - boolean - 'null' description: >- Derived validity; null when the expiry is unknown, false when expired. expires_at: type: - string - 'null' format: date-time description: >- The current MOT expiry date (latest MOT test), or null if unknown. risk: type: string enum: - none - low - medium - high - critical description: >- Platform risk band derived from the MOT expiry using fixed 30/20/10-day thresholds for low/medium/high; an expired MOT is critical. records: type: integer description: Number of MOT records on file. last: type: object properties: at: type: - string - 'null' format: date-time id: type: - string - 'null' format: uuid tax: type: object description: Rolled-up tax status. properties: is_valid: type: - boolean - 'null' description: >- Derived validity; null when the expiry is unknown, false when expired. expires_at: type: - string - 'null' format: date-time description: >- The current tax expiry date, or null if unknown or the vehicle is SORN. risk: type: string enum: - none - low - medium - high - critical description: >- Platform risk band derived from the tax expiry using fixed 30/20/10-day thresholds for low/medium/high; expired tax is critical. due: type: - string - 'null' checks: type: object description: Rolled-up inspection and inventory check references. properties: inventory: type: object properties: count: type: integer last: type: object properties: at: type: - string - 'null' format: date-time id: type: - string - 'null' format: uuid inspection: type: object properties: count: type: integer last: type: object properties: at: type: - string - 'null' format: date-time id: type: - string - 'null' format: uuid dvla: type: - object - 'null' description: The full DVLA VES + MOT payload as last seen. properties: mot: type: - object - 'null' properties: exists: type: boolean last_sync: type: - string - 'null' format: date-time data: type: - object - 'null' ves: type: - object - 'null' properties: exists: type: boolean last_sync: type: - string - 'null' format: date-time data: type: - object - 'null' VehicleRelationships: type: object description: Relationships for a vehicle required: - organisation properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' specification: type: object required: - data properties: data: $ref: '#/components/schemas/VehicleSpecificationRelationship' equipment: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/EquipmentItemRelationship' categories: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/VehicleCategoryRelationship' certifications: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/VehicleCertificationRelationship' allocated_person: type: object properties: data: $ref: '#/components/schemas/UserRelationship' meta: $ref: '#/components/schemas/AllocationMeta' allocated_scheme: type: object properties: data: $ref: '#/components/schemas/SchemeRelationship' meta: $ref: '#/components/schemas/AllocationMeta' allocated_work_order: type: object properties: data: $ref: '#/components/schemas/WorkOrderRelationship' meta: $ref: '#/components/schemas/AllocationMeta' allocated_location: type: object properties: data: $ref: '#/components/schemas/LocationRelationship' meta: $ref: '#/components/schemas/AllocationMeta' pre_allocations: type: object description: Read-only. Planned pre-allocation reservations for the vehicle. readOnly: true required: - data properties: data: type: array items: type: object required: - id - type properties: id: type: string format: uuid type: type: string const: vehicle-pre-allocations folder: type: object description: The vehicle's general documents root folder. required: - data properties: data: $ref: '#/components/schemas/FolderRelationship' OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations VehicleSpecificationRelationship: type: object description: Represents a relationship to a vehicle specification required: - id - type properties: id: type: string format: uuid description: The unique identifier for the vehicle specification type: type: string const: vehicle-specifications EquipmentItemRelationship: type: object description: Represents a relationship to an equipment item required: - id - type properties: id: type: string format: uuid description: The unique identifier for the equipment item type: type: string const: equipment-items VehicleCategoryRelationship: type: object description: Represents a relationship to a vehicle category required: - id - type properties: id: type: string format: uuid description: The unique identifier of the vehicle category type: type: string const: vehicle-categories VehicleCertificationRelationship: type: object description: Represents a relationship to a vehicle certification required: - id - type properties: id: type: string format: uuid description: The unique identifier for the vehicle certification type: type: string const: vehicle-certifications UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users AllocationMeta: type: object description: Metadata for a current-allocation relationship. properties: starts_at: type: - string - 'null' format: date-time description: When the allocation should take effect. SchemeRelationship: type: object description: Represents a relationship to a scheme required: - id - type properties: id: type: string format: uuid description: The unique identifier of the scheme type: type: string const: schemes WorkOrderRelationship: type: object description: Represents a relationship to a work order required: - id - type properties: id: type: string format: uuid description: The unique identifier of the work order type: type: string const: work-orders LocationRelationship: type: object description: Represents a relationship to a location required: - id - type properties: id: type: string format: uuid description: The unique identifier of the location type: type: string const: locations FolderRelationship: type: object description: Represents a relationship to a folder required: - id - type properties: id: type: string format: uuid description: The unique identifier of the folder type: type: string const: folders headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 ````