servers.asc #1

=== Helix Versioning Engine Servers

[[get_p4_vX_servers]]
==== `GET /p4/v[api]/servers`
    
Lists available servers in the system.
The resources of this list are summaries of servers in the system.

===== 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_servers.html[`p4 -ztag servers`] command.
For more field information refer to the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_servers.html[command reference].

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

An example response body might look like:

[source,json]
----
[
  {
    "ServerID": "master-1666",
    "Name": "master-1666",
    "Address": "",
    "Type": "server",
    "Services": "commit-server",
    "Description": "Created by su-superuser.\n"
  },
  {
    "ServerID": "buildfarm",
    "Name": "buildfarm",
    "Address": "",
    "Type": "server",
    "Services": "db-read,db-replication,bound-clients,file-replication",
    "Description": "Created by su-superuser.\n"
  }
]
----

===== Ruby Client

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




[[post_p4_vX_servers]]
==== `POST /p4/v[api]/servers`
    
Creates a new server specification, like the `p4 server` command.

There are no other parameters to this method.

===== 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_server.html[p4 server] command.

For example:

[source,json]
----
{
  "ServerID": "new_server",
  "Description": "A new server for stuff",
  "Type": "server",
  "Services": "standard"
}
----

===== 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_server-instance_method[`HelixWebServicesClient#create_server`]




[[get_p4_vX_servers_server]]
==== `GET /p4/v[api]/servers/[server]`

Return server details, similar to the `p4 server -o` command.

===== Request URL Path Parameters

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

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

| server
| The server name.
|===

===== 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 Data

Returns the form fields of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_server.html[`p4 -ztag server [server name]`] command.
For more information, see the command reference.
The main difference between the details and list view is the inclusion of the View field.

===== Example JSON Response

[source,json]
----
{
  "ServerID": "master-1666",
  "Type": "server",
  "Name": "master-1666",
  "Services": "commit-server",
  "Description": "Created by su-jsmith.\n"
}
----

===== Ruby Client

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




[[patch_p4_vX_servers_server]]
==== `PATCH /p4/v[api]/servers/[server]`
    
Update server specifications, similar to the `p4 server` command.
Only the specified parameters in the body will be changed.

===== Request URL Path Parameters

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

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

| server
| The name of the server
|===

===== 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

A single JSON object containing form fields of the http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_server.html[`p4 -ztag server [server name]`] command.

===== Response Headers

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

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

===== Example JSON Request Body

[source,json]
----
{
  "Description": "The updated new-server description.\n"
}
----

===== Ruby Client

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




[[delete_p4_vX_servers_server]]
===== `DELETE /p4/v[api]/servers/[server]`
    
Removes the server specification, similar to the `p4 server -d` command.

====== Request URL Path Parameters

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

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

| server
| The name of the server
|===

===== 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`
|===

===== Ruby Client

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