doc/api/ApiClients.textile

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