protections.asc #1

=== Helix Versioning Engine Protections

[[get_helix_versioning_engine_vX_protections]]
==== `GET /helix_versioning_engine/v[api]/protections`
    
Lists available protections in the system.
The resources of this list are summaries of protections in the system.

This method likely requires superuser access.

===== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Response Body JSON

The values of this method are based on the result of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_protect.html[`p4 -ztag protect -o`] command.

See <<error_responses>> for the format of failures.

An example response body might look like:

[source,json]
----
{
  "Protections": [
    "write user * * //...",
    "super user super * //..."
  ]
}
----

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#protections-instance_method[`HelixWebServicesClient#protections`]




[[post_helix_versioning_engine_vX_protections]]
==== `POST /helix_versioning_engine/v[api]/protections`
    
Update the protections table.

This method likely requires superuser access.

===== Request URL Path Parameters

[cols="2*", options="header"]
|===
| Parameter
| Description

| `api`
| The Helix Versioning Engine API level.
|===

===== Request Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Authorization`
| See <<authentication>>

| `Accept`
| `application/json`

| `Content-Type`
| `application/json`

| `X-Perforce-Helix_Web_Services-*`
| See <<per_request_configuration>>
|===

===== Request Body JSON

Properties of the JSON object are the form fields of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_protect.html[`p4 protect`] command.

For example:

[source,json]
----
{
  "Protections": [
    "write user * * //...",
    "super user super * //...",
    "super user jdoe * //..."
  ]
}
----

===== Response Headers

[cols="2*", options="header"]
|===
| Header Name
| Notes

| `Content-Type`
| `application/json`
|===

===== Ruby Client

See link:./helix_web_services_client_ruby/HelixWebServicesClient.html#create_label-instance_method[`HelixWebServicesClient#create_label`]