> 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-auth-rule.md).

# /api/cms/auth‑rule

## GET /api/cms/auth-rule

> \--notset--

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/auth-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_cms_auth-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_channel_id","ruleid"]}}},"paths":{"/api/cms/auth-rule":{"get":{"description":"--notset--","tags":["/api/cms/auth-rule"],"parameters":[{"name":"cms_channel_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_cms_auth-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_cms_auth-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_cms_auth-rule"}}}}}}}}}
```

## POST /api/cms/auth-rule

> Add new cms auth rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/auth-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_cms_auth-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_channel_id","rule_type"]}}},"paths":{"/api/cms/auth-rule":{"post":{"description":"Add new cms auth rule","tags":["/api/cms/auth-rule"],"parameters":[{"name":"cms_channel_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"content_area","in":"query","schema":{"type":"string"},"required":false},{"name":"rule_type","in":"query","schema":{"type":"string"},"required":true},{"name":"site","in":"query","schema":{"type":"string"},"required":false},{"name":"tour","in":"query","schema":{"type":"string"},"required":false},{"name":"option","in":"query","schema":{"type":"string"},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW","type":"string"},"required":false},{"name":"end_time","in":"query","schema":{"default":"FOREVER","type":"string"},"required":false},{"name":"trial","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"signup","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"signup_timeframe","in":"query","schema":{"type":"integer"},"required":false},{"name":"signup_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"status","in":"query","schema":{"default":0,"type":"integer"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_cms_auth-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_cms_auth-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_cms_auth-rule"}}}}}}}}}
```

## DELETE /api/cms/auth-rule

> Disable auth rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/auth-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_cms_auth-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_channel_id","ruleid"]}}},"paths":{"/api/cms/auth-rule":{"delete":{"description":"Disable auth rule","tags":["/api/cms/auth-rule"],"parameters":[{"name":"cms_channel_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_cms_auth-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_cms_auth-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_cms_auth-rule"}}}}}}}}}
```

## PATCH /api/cms/auth-rule

> Edit auth rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/auth-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_cms_auth-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_channel_id","ruleid","rule_type"]}}},"paths":{"/api/cms/auth-rule":{"patch":{"description":"Edit auth rule","tags":["/api/cms/auth-rule"],"parameters":[{"name":"cms_channel_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"content_area","in":"query","schema":{"type":"string"},"required":false},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true},{"name":"rule_type","in":"query","schema":{"type":"string"},"required":true},{"name":"site","in":"query","schema":{"type":"string"},"required":false},{"name":"tour","in":"query","schema":{"type":"string"},"required":false},{"name":"option","in":"query","schema":{"type":"string"},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW","type":"string"},"required":false},{"name":"end_time","in":"query","schema":{"default":"FOREVER","type":"string"},"required":false},{"name":"trial","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"signup","in":"query","schema":{"default":0,"type":"integer"},"required":false},{"name":"signup_timeframe","in":"query","schema":{"type":"integer"},"required":false},{"name":"signup_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"status","in":"query","schema":{"default":0,"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_cms_auth-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_cms_auth-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_cms_auth-rule"}}}}}}}}}
```