Freezer Policies¶
The following is an overview of all available policies in Freezer API. For a sample configuration file, refer to Sample Freezer Policy File.
freezer-api¶
actions:create
- Default:
<empty string>
- Operations:
POST
/v1/actions
Creates action.
actions:delete
- Default:
<empty string>
- Operations:
DELETE
/v1/actions/{action_id}
Delete action.
actions:get
- Default:
<empty string>
- Operations:
GET
/v1/actions/{action_id}
Show actions.
actions:get_all
- Default:
<empty string>
- Operations:
GET
/v1/actions
Lists actions.
actions:update
- Default:
<empty string>
- Operations:
PATCH
/v1/actions/{action_id}
Updates actions.
actions:replace
- Default:
<empty string>
- Operations:
PUT
/v1/actions/{action_id}
Creates/replaces the specified action.
backups:create
- Default:
<empty string>
- Operations:
POST
/v1/backups
Creates backup entry.
backups:delete
- Default:
<empty string>
- Operations:
DELETE
/v1/backups/{backup_id}
Delete backup.
backups:get
- Default:
<empty string>
- Operations:
GET
/v1/backups/{backup_id}
Show backups.
backups:get_all
- Default:
<empty string>
- Operations:
GET
/v1/backups
Lists backups.
context_is_admin
- Default:
role:admin
(no description provided)
admin_or_owner
- Default:
is_admin:True or project_id:%(project_id)s
(no description provided)
clients:create
- Default:
<empty string>
- Operations:
POST
/v1/clients
Create client entry.
clients:delete
- Default:
<empty string>
- Operations:
DELETE
/v1/clients/{client_id}
Delete specified client.
clients:get
- Default:
<empty string>
- Operations:
GET
/v1/clients/{client_id}
Show clients.
clients:get_all
- Default:
<empty string>
- Operations:
GET
/v1/clients
List clients.
jobs:create
- Default:
<empty string>
- Operations:
POST
/v1/jobs
Creates job.
jobs:delete
- Default:
<empty string>
- Operations:
DELETE
/v1/jobs/{job_id}
Delete jobs.
jobs:get
- Default:
<empty string>
- Operations:
GET
/v1/jobs/{job_id}
Show jobs.
jobs:get_all
- Default:
<empty string>
- Operations:
GET
/v1/jobs
Lists jobs.
jobs:update
- Default:
<empty string>
- Operations:
PATCH
/v1/jobs/{job_id}
Updates jobs.
jobs:event:create
- Default:
<empty string>
- Operations:
POST
/v1/jobs/{job_id}/event
Create an event on the specified job
sessions:create
- Default:
<empty string>
- Operations:
POST
/v1/sessions
Creates session.
sessions:delete
- Default:
<empty string>
- Operations:
DELETE
/v1/sessions/{session_id}
Delete session.
sessions:get
- Default:
<empty string>
- Operations:
GET
/v1/sessions/{session_id}
Show sessions.
sessions:get_all
- Default:
<empty string>
- Operations:
GET
/v1/sessions
Lists sessions.
sessions:update
- Default:
<empty string>
- Operations:
PATCH
/v1/sessions/{session_id}
Updates sessions.
sessions:replace
- Default:
<empty string>
- Operations:
PUT
/v1/sessions/{session_id}
Creates/replaces the specified session.
sessions:action:create
- Default:
<empty string>
- Operations:
POST
/v1/sessions/{session_id}/action
Executes an action on the specified session.
sessions:job:add
- Default:
<empty string>
- Operations:
PUT
/v1/sessions/{session_id}/jobs/{job_id}
Adds a certain job to a session.
sessions:job:remove
- Default:
<empty string>
- Operations:
DELETE
/v1/sessions/{session_id}
Remove a job from a session.