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

# /api/cms/format

## GET /api/cms/format

> Get content format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_cms_format":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"paths":{"/api/cms/format":{"get":{"description":"Get content format","tags":["/api/cms/format"],"parameters":[{"name":"cms_format_id","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"fields","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"settings","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_cms_format"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_cms_format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_cms_format"}}}}}}}}}
```

## POST /api/cms/format

> Add content format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_cms_format":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["format","display","container"]}}},"paths":{"/api/cms/format":{"post":{"description":"Add content format","tags":["/api/cms/format"],"parameters":[{"name":"format","in":"query","schema":{"type":"string"},"required":true},{"name":"display","in":"query","schema":{"type":"string"},"required":true},{"name":"vcodec","in":"query","schema":{"default":"--notset--","type":"string"},"required":false},{"name":"vbitrate","in":"query","schema":{"type":"integer"},"required":false},{"name":"tune","in":"query","schema":{"type":"string"},"required":false},{"name":"preset","in":"query","schema":{"type":"string"},"required":false},{"name":"crf","in":"query","schema":{"type":"string"},"required":false},{"name":"acodec","in":"query","schema":{"default":"--notset--","type":"string"},"required":false},{"name":"abitrate","in":"query","schema":{"type":"integer"},"required":false},{"name":"container","in":"query","schema":{"type":"string"},"required":true},{"name":"orientation_vertical","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"orientation_square","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"orientation_horizontal","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"resolution_y","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"template","in":"query","schema":{"default":"--notset--","type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_cms_format"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_cms_format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_cms_format"}}}}}}}}}
```

## DELETE /api/cms/format

> Delete content format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_cms_format":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_format_id"]}}},"paths":{"/api/cms/format":{"delete":{"description":"Delete content format","tags":["/api/cms/format"],"parameters":[{"name":"cms_format_id","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_cms_format"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_cms_format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_cms_format"}}}}}}}}}
```

## PATCH /api/cms/format

> Update content format

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/format"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_cms_format":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_format_id","display"]}}},"paths":{"/api/cms/format":{"patch":{"description":"Update content format","tags":["/api/cms/format"],"parameters":[{"name":"cms_format_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"format","in":"query","schema":{"type":"string"},"required":false},{"name":"display","in":"query","schema":{"type":"string"},"required":true},{"name":"vcodec","in":"query","schema":{"type":"string"},"required":false},{"name":"tune","in":"query","schema":{"type":"string"},"required":false},{"name":"preset","in":"query","schema":{"type":"string"},"required":false},{"name":"crf","in":"query","schema":{"type":"string"},"required":false},{"name":"vbitrate","in":"query","schema":{"type":"integer"},"required":false},{"name":"acodec","in":"query","schema":{"type":"string"},"required":false},{"name":"abitrate","in":"query","schema":{"type":"integer"},"required":false},{"name":"container","in":"query","schema":{"type":"string"},"required":false},{"name":"orientation_vertical","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"orientation_square","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"orientation_horizontal","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"resolution_y","in":"query","schema":{"type":"integer"},"required":false},{"name":"template","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_cms_format"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_cms_format"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_cms_format"}}}}}}}}}
```