doc/api/ApiClients.textile

   1 ---
   2 layout: default
   3 navsection: api
   4 title: "Resource: ApiClient"
   5 navorder: 101
   6 ---
   7
   8 h1. ApiClients
   9
  10 An **ApiClient** represents a client program that has issued a request to the API server.
  11
  12
  13 h2. Methods
  14
  15 See "REST methods for working with Arvados resources":methods.html
  16
  17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@
  18
  19 h2. Creation
  20
  21 h3. Prerequisites
  22
  23 Prerequisites for creating an ApiClient.
  24
  25 h3. Side effects
  26
  27 Side effects of creating an ApiClient.
  28
  29 h2. Resources
  30
  31 Each ApiClient has, in addition to the usual "attributes of Arvados resources":resources.html:
  32
  33 table(table table-bordered table-condensed).
  34 |*Property name*|*Value*|*Description*|*Example*|
  35 |name|string|||
  36 |url_prefix|string|||
  37 |is_trusted|boolean|||