> For the complete documentation index, see [llms.txt](https://docs.geosamples.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geosamples.org/api/platforms.md).

# Platforms

## List platforms

> Paginated platforms for the current user: personal by default, team-scoped when \`team\_id\` is set, or SESAR-code–scoped when \`sesar\_code\` is set. Optional \`query\` filters by label, description, or normalized label.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaginatedPlatformListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PlatformListPagination"}}}},"PlatformListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Platform"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}},"paths":{"/api/platforms/":{"get":{"operationId":"platforms_list","description":"Paginated platforms for the current user: personal by default, team-scoped when `team_id` is set, or SESAR-code–scoped when `sesar_code` is set. Optional `query` filters by label, description, or normalized label.","summary":"List platforms","parameters":[{"in":"query","name":"ordering","schema":{"type":"string"},"description":"Sort field; prefix with `-` for descending. Allowed: id, label, date_commissioned."},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page number (1-based)."},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"Items per page (max 2000)."},{"in":"query","name":"query","schema":{"type":"string"},"description":"Substring filter on label, description, and norm_label."},{"in":"query","name":"sesar_code","schema":{"type":"string"},"description":"When set, scope list to this SESAR code (view_platform permission)."},{"in":"query","name":"team_id","schema":{"type":"integer"},"description":"When set, list platforms for this team (membership required)."}],"tags":["Platforms"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedPlatformListPaginationList"}}},"description":""}}}}}}
```

## Create platform

> Creates a platform. Ownership determined by either: \`team\_owner\_id\` explicitly set in body, or defaults to the current user.

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]},"PlatformCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Platform"}},"required":["data"]}}},"paths":{"/api/platforms/":{"post":{"operationId":"platforms_create","description":"Creates a platform. Ownership determined by either: `team_owner_id` explicitly set in body, or defaults to the current user.","summary":"Create platform","tags":["Platforms"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Platform"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Platform"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCreateSuccessResponse"}}},"description":""}}}}}}
```

## GET /api/platforms/{id}/

> Retrieve platform

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PlatformDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Platform"}},"required":["data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}},"paths":{"/api/platforms/{id}/":{"get":{"operationId":"platforms_retrieve","summary":"Retrieve platform","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true}],"tags":["Platforms"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformDetailSuccessResponse"}}},"description":""}}}}}}
```

## DELETE /api/platforms/{id}/

> Delete platform

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PlatformDeleteSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlatformDeleteSuccessData"}},"required":["data"]},"PlatformDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}},"paths":{"/api/platforms/{id}/":{"delete":{"operationId":"platforms_destroy","summary":"Delete platform","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true}],"tags":["Platforms"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformDeleteSuccessResponse"}}},"description":""}}}}}}
```

## PATCH /api/platforms/{id}/

> Update platform

```json
{"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"security":[{"tokenAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PatchedPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}}},"PlatformUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Platform"}},"required":["data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}},"paths":{"/api/platforms/{id}/":{"patch":{"operationId":"platforms_partial_update","summary":"Update platform","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"required":true}],"tags":["Platforms"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedPlatform"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedPlatform"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedPlatform"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformUpdateSuccessResponse"}}},"description":""}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.geosamples.org/api/platforms.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.