---
layout: default
navsection: api
navmenu: API Methods
title: "keep_services"

...

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_services@

UUID type: @bi6l4@

Required arguments are displayed in %{background:#ccffcc}green%.

h2. Resource

The keep_services resource storage servers and proxies available on the cluster for persistent storage and retrieval of keep blocks.

Each KeepService has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|service_host|string|||
|service_port|integer|||
|service_ssl_flag|boolean|||
|service_type|string|||

h2. Methods

h3. accessible

Get a list of keep services that are accessible to the requesting client.  Unlike @list@, this is context-sensitive based on the requester, for example providing the list of actual Keep servers when inside the cluster, but providing a proxy service if client contacts Arvados from outside the cluster.

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |

h3. create

Create a new KeepService.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|keep_disk|object||query||

h3. delete

Delete an existing KeepService.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||

h3. get

Gets a KeepService's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||

h3. list

List keep_services.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of keep_services to return.|query||
|order|string|Order in which to return matching keep_services.|query||
|filters|array|Conditions for filtering keep_services.|query||

h3. update

Update attributes of an existing KeepService.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
|keep_service|object||query||