> 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-banner.md).

# /api/cms/banner

## GET /api/cms/banner

> Get details of banner.

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

## POST /api/cms/banner

> Add theme banner

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/banner"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_cms_banner":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_theme_id","img_type"]}}},"paths":{"/api/cms/banner":{"post":{"description":"Add theme banner","tags":["/api/cms/banner"],"parameters":[{"name":"cms_theme_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"start","in":"query","schema":{"type":"string"},"required":false},{"name":"end","in":"query","schema":{"type":"string"},"required":false},{"name":"img_type","in":"query","schema":{"type":"string"},"required":true},{"name":"type","in":"query","schema":{"default":"--notset--","type":"string"},"required":false},{"name":"settings","in":"query","schema":{"type":"string"},"required":false},{"name":"status","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_cms_banner"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_cms_banner"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_cms_banner"}}}}}}}}}
```

## DELETE /api/cms/banner

> Delete Banner

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

## PATCH /api/cms/banner

> Edit theme banner

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/banner"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_cms_banner":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_banner_id"]}}},"paths":{"/api/cms/banner":{"patch":{"description":"Edit theme banner","tags":["/api/cms/banner"],"parameters":[{"name":"cms_banner_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"start","in":"query","schema":{"type":"string"},"required":false},{"name":"end","in":"query","schema":{"type":"string"},"required":false},{"name":"img_type","in":"query","schema":{"type":"string"},"required":false},{"name":"type","in":"query","schema":{"type":"string"},"required":false},{"name":"settings","in":"query","schema":{"type":"string"},"required":false},{"name":"status","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_cms_banner"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_cms_banner"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_cms_banner"}}}}}}}}}
```