sdk/R/arvados-v1-discovery.json

   1 {
   2   "auth": {
   3     "oauth2": {
   4       "scopes": {
   5         "https://api.arvados.org/auth/arvados": {
   6           "description": "View and manage objects"
   7         },
   8         "https://api.arvados.org/auth/arvados.readonly": {
   9           "description": "View objects"
  10         }
  11       }
  12     }
  13   },
  14   "basePath": "/arvados/v1/",
  15   "batchPath": "batch",
  16   "description": "The API to interact with Arvados.",
  17   "discoveryVersion": "v1",
  18   "documentationLink": "http://doc.arvados.org/api/index.html",
  19   "id": "arvados:v1",
  20   "kind": "discovery#restDescription",
  21   "name": "arvados",
  22   "parameters": {
  23     "alt": {
  24       "type": "string",
  25       "description": "Data format for the response.",
  26       "default": "json",
  27       "enum": [
  28         "json"
  29       ],
  30       "enumDescriptions": [
  31         "Responses with Content-Type of application/json"
  32       ],
  33       "location": "query"
  34     },
  35     "fields": {
  36       "type": "string",
  37       "description": "Selector specifying which fields to include in a partial response.",
  38       "location": "query"
  39     },
  40     "key": {
  41       "type": "string",
  42       "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  43       "location": "query"
  44     },
  45     "oauth_token": {
  46       "type": "string",
  47       "description": "OAuth 2.0 token for the current user.",
  48       "location": "query"
  49     }
  50   },
  51   "protocol": "rest",
  52   "resources": {
  53     "api_client_authorizations": {
  54       "methods": {
  55         "get": {
  56           "id": "arvados.api_client_authorizations.get",
  57           "path": "api_client_authorizations/{uuid}",
  58           "httpMethod": "GET",
  59           "description": "Get a ApiClientAuthorization record by UUID.",
  60           "parameters": {
  61             "uuid": {
  62               "type": "string",
  63               "description": "The UUID of the ApiClientAuthorization to return.",
  64               "required": true,
  65               "location": "path"
  66             },
  67             "select": {
  68               "type": "array",
  69               "description": "An array of names of attributes to return in the response.",
  70               "required": false,
  71               "location": "query"
  72             }
  73           },
  74           "parameterOrder": [
  75             "uuid"
  76           ],
  77           "response": {
  78             "$ref": "ApiClientAuthorization"
  79           },
  80           "scopes": [
  81             "https://api.arvados.org/auth/arvados",
  82             "https://api.arvados.org/auth/arvados.readonly"
  83           ]
  84         },
  85         "list": {
  86           "id": "arvados.api_client_authorizations.list",
  87           "path": "api_client_authorizations",
  88           "httpMethod": "GET",
  89           "description": "Retrieve a ApiClientAuthorizationList.",
  90           "parameters": {
  91             "filters": {
  92               "type": "array",
  93               "required": false,
  94               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
  95               "location": "query"
  96             },
  97             "where": {
  98               "type": "object",
  99               "required": false,
 100               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
 101               "location": "query"
 102             },
 103             "order": {
 104               "type": "array",
 105               "required": false,
 106               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
 107               "location": "query"
 108             },
 109             "select": {
 110               "type": "array",
 111               "description": "An array of names of attributes to return from each matching object.",
 112               "required": false,
 113               "location": "query"
 114             },
 115             "distinct": {
 116               "type": "boolean",
 117               "required": false,
 118               "default": "false",
 119               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
 120               "location": "query"
 121             },
 122             "limit": {
 123               "type": "integer",
 124               "required": false,
 125               "default": "100",
 126               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
 127               "location": "query"
 128             },
 129             "offset": {
 130               "type": "integer",
 131               "required": false,
 132               "default": "0",
 133               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
 134               "location": "query"
 135             },
 136             "count": {
 137               "type": "string",
 138               "required": false,
 139               "default": "exact",
 140               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
 141               "location": "query"
 142             },
 143             "cluster_id": {
 144               "type": "string",
 145               "description": "Cluster ID of a federated cluster to return objects from",
 146               "location": "query",
 147               "required": false
 148             },
 149             "bypass_federation": {
 150               "type": "boolean",
 151               "required": false,
 152               "default": "false",
 153               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
 154               "location": "query"
 155             }
 156           },
 157           "response": {
 158             "$ref": "ApiClientAuthorizationList"
 159           },
 160           "scopes": [
 161             "https://api.arvados.org/auth/arvados",
 162             "https://api.arvados.org/auth/arvados.readonly"
 163           ]
 164         },
 165         "create": {
 166           "id": "arvados.api_client_authorizations.create",
 167           "path": "api_client_authorizations",
 168           "httpMethod": "POST",
 169           "description": "Create a new ApiClientAuthorization.",
 170           "parameters": {
 171             "select": {
 172               "type": "array",
 173               "description": "An array of names of attributes to return in the response.",
 174               "required": false,
 175               "location": "query"
 176             },
 177             "ensure_unique_name": {
 178               "type": "boolean",
 179               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
 180               "location": "query",
 181               "required": false,
 182               "default": "false"
 183             },
 184             "cluster_id": {
 185               "type": "string",
 186               "description": "Cluster ID of a federated cluster where this object should be created.",
 187               "location": "query",
 188               "required": false
 189             }
 190           },
 191           "request": {
 192             "required": true,
 193             "properties": {
 194               "api_client_authorization": {
 195                 "$ref": "ApiClientAuthorization"
 196               }
 197             }
 198           },
 199           "response": {
 200             "$ref": "ApiClientAuthorization"
 201           },
 202           "scopes": [
 203             "https://api.arvados.org/auth/arvados"
 204           ]
 205         },
 206         "update": {
 207           "id": "arvados.api_client_authorizations.update",
 208           "path": "api_client_authorizations/{uuid}",
 209           "httpMethod": "PUT",
 210           "description": "Update attributes of an existing ApiClientAuthorization.",
 211           "parameters": {
 212             "uuid": {
 213               "type": "string",
 214               "description": "The UUID of the ApiClientAuthorization to update.",
 215               "required": true,
 216               "location": "path"
 217             },
 218             "select": {
 219               "type": "array",
 220               "description": "An array of names of attributes to return in the response.",
 221               "required": false,
 222               "location": "query"
 223             }
 224           },
 225           "request": {
 226             "required": true,
 227             "properties": {
 228               "api_client_authorization": {
 229                 "$ref": "ApiClientAuthorization"
 230               }
 231             }
 232           },
 233           "response": {
 234             "$ref": "ApiClientAuthorization"
 235           },
 236           "scopes": [
 237             "https://api.arvados.org/auth/arvados"
 238           ]
 239         },
 240         "delete": {
 241           "id": "arvados.api_client_authorizations.delete",
 242           "path": "api_client_authorizations/{uuid}",
 243           "httpMethod": "DELETE",
 244           "description": "Delete an existing ApiClientAuthorization.",
 245           "parameters": {
 246             "uuid": {
 247               "type": "string",
 248               "description": "The UUID of the ApiClientAuthorization to delete.",
 249               "required": true,
 250               "location": "path"
 251             }
 252           },
 253           "response": {
 254             "$ref": "ApiClientAuthorization"
 255           },
 256           "scopes": [
 257             "https://api.arvados.org/auth/arvados"
 258           ]
 259         },
 260         "create_system_auth": {
 261           "id": "arvados.api_client_authorizations.create_system_auth",
 262           "path": "api_client_authorizations/create_system_auth",
 263           "httpMethod": "POST",
 264           "description": "Create a token for the system (\"root\") user.",
 265           "parameters": {
 266             "scopes": {
 267               "type": "array",
 268               "required": false,
 269               "default": "[\"all\"]",
 270               "description": "An array of strings defining the scope of resources this token will be allowed to access. Refer to the [scopes reference][] for details.\n\n[scopes reference]: https://doc.arvados.org/api/tokens.html#scopes\n",
 271               "location": "query"
 272             }
 273           },
 274           "response": {
 275             "$ref": "ApiClientAuthorization"
 276           },
 277           "scopes": [
 278             "https://api.arvados.org/auth/arvados"
 279           ]
 280         },
 281         "current": {
 282           "id": "arvados.api_client_authorizations.current",
 283           "path": "api_client_authorizations/current",
 284           "httpMethod": "GET",
 285           "description": "Return all metadata for the token used to authorize this request.",
 286           "parameters": {},
 287           "response": {
 288             "$ref": "ApiClientAuthorization"
 289           },
 290           "scopes": [
 291             "https://api.arvados.org/auth/arvados"
 292           ]
 293         }
 294       }
 295     },
 296     "authorized_keys": {
 297       "methods": {
 298         "get": {
 299           "id": "arvados.authorized_keys.get",
 300           "path": "authorized_keys/{uuid}",
 301           "httpMethod": "GET",
 302           "description": "Get a AuthorizedKey record by UUID.",
 303           "parameters": {
 304             "uuid": {
 305               "type": "string",
 306               "description": "The UUID of the AuthorizedKey to return.",
 307               "required": true,
 308               "location": "path"
 309             },
 310             "select": {
 311               "type": "array",
 312               "description": "An array of names of attributes to return in the response.",
 313               "required": false,
 314               "location": "query"
 315             }
 316           },
 317           "parameterOrder": [
 318             "uuid"
 319           ],
 320           "response": {
 321             "$ref": "AuthorizedKey"
 322           },
 323           "scopes": [
 324             "https://api.arvados.org/auth/arvados",
 325             "https://api.arvados.org/auth/arvados.readonly"
 326           ]
 327         },
 328         "list": {
 329           "id": "arvados.authorized_keys.list",
 330           "path": "authorized_keys",
 331           "httpMethod": "GET",
 332           "description": "Retrieve a AuthorizedKeyList.",
 333           "parameters": {
 334             "filters": {
 335               "type": "array",
 336               "required": false,
 337               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
 338               "location": "query"
 339             },
 340             "where": {
 341               "type": "object",
 342               "required": false,
 343               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
 344               "location": "query"
 345             },
 346             "order": {
 347               "type": "array",
 348               "required": false,
 349               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
 350               "location": "query"
 351             },
 352             "select": {
 353               "type": "array",
 354               "description": "An array of names of attributes to return from each matching object.",
 355               "required": false,
 356               "location": "query"
 357             },
 358             "distinct": {
 359               "type": "boolean",
 360               "required": false,
 361               "default": "false",
 362               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
 363               "location": "query"
 364             },
 365             "limit": {
 366               "type": "integer",
 367               "required": false,
 368               "default": "100",
 369               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
 370               "location": "query"
 371             },
 372             "offset": {
 373               "type": "integer",
 374               "required": false,
 375               "default": "0",
 376               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
 377               "location": "query"
 378             },
 379             "count": {
 380               "type": "string",
 381               "required": false,
 382               "default": "exact",
 383               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
 384               "location": "query"
 385             },
 386             "cluster_id": {
 387               "type": "string",
 388               "description": "Cluster ID of a federated cluster to return objects from",
 389               "location": "query",
 390               "required": false
 391             },
 392             "bypass_federation": {
 393               "type": "boolean",
 394               "required": false,
 395               "default": "false",
 396               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
 397               "location": "query"
 398             }
 399           },
 400           "response": {
 401             "$ref": "AuthorizedKeyList"
 402           },
 403           "scopes": [
 404             "https://api.arvados.org/auth/arvados",
 405             "https://api.arvados.org/auth/arvados.readonly"
 406           ]
 407         },
 408         "create": {
 409           "id": "arvados.authorized_keys.create",
 410           "path": "authorized_keys",
 411           "httpMethod": "POST",
 412           "description": "Create a new AuthorizedKey.",
 413           "parameters": {
 414             "select": {
 415               "type": "array",
 416               "description": "An array of names of attributes to return in the response.",
 417               "required": false,
 418               "location": "query"
 419             },
 420             "ensure_unique_name": {
 421               "type": "boolean",
 422               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
 423               "location": "query",
 424               "required": false,
 425               "default": "false"
 426             },
 427             "cluster_id": {
 428               "type": "string",
 429               "description": "Cluster ID of a federated cluster where this object should be created.",
 430               "location": "query",
 431               "required": false
 432             }
 433           },
 434           "request": {
 435             "required": true,
 436             "properties": {
 437               "authorized_key": {
 438                 "$ref": "AuthorizedKey"
 439               }
 440             }
 441           },
 442           "response": {
 443             "$ref": "AuthorizedKey"
 444           },
 445           "scopes": [
 446             "https://api.arvados.org/auth/arvados"
 447           ]
 448         },
 449         "update": {
 450           "id": "arvados.authorized_keys.update",
 451           "path": "authorized_keys/{uuid}",
 452           "httpMethod": "PUT",
 453           "description": "Update attributes of an existing AuthorizedKey.",
 454           "parameters": {
 455             "uuid": {
 456               "type": "string",
 457               "description": "The UUID of the AuthorizedKey to update.",
 458               "required": true,
 459               "location": "path"
 460             },
 461             "select": {
 462               "type": "array",
 463               "description": "An array of names of attributes to return in the response.",
 464               "required": false,
 465               "location": "query"
 466             }
 467           },
 468           "request": {
 469             "required": true,
 470             "properties": {
 471               "authorized_key": {
 472                 "$ref": "AuthorizedKey"
 473               }
 474             }
 475           },
 476           "response": {
 477             "$ref": "AuthorizedKey"
 478           },
 479           "scopes": [
 480             "https://api.arvados.org/auth/arvados"
 481           ]
 482         },
 483         "delete": {
 484           "id": "arvados.authorized_keys.delete",
 485           "path": "authorized_keys/{uuid}",
 486           "httpMethod": "DELETE",
 487           "description": "Delete an existing AuthorizedKey.",
 488           "parameters": {
 489             "uuid": {
 490               "type": "string",
 491               "description": "The UUID of the AuthorizedKey to delete.",
 492               "required": true,
 493               "location": "path"
 494             }
 495           },
 496           "response": {
 497             "$ref": "AuthorizedKey"
 498           },
 499           "scopes": [
 500             "https://api.arvados.org/auth/arvados"
 501           ]
 502         }
 503       }
 504     },
 505     "collections": {
 506       "methods": {
 507         "get": {
 508           "id": "arvados.collections.get",
 509           "path": "collections/{uuid}",
 510           "httpMethod": "GET",
 511           "description": "Get a Collection record by UUID.",
 512           "parameters": {
 513             "uuid": {
 514               "type": "string",
 515               "description": "The UUID of the Collection to return.",
 516               "required": true,
 517               "location": "path"
 518             },
 519             "select": {
 520               "type": "array",
 521               "description": "An array of names of attributes to return in the response.",
 522               "required": false,
 523               "location": "query"
 524             },
 525             "include_trash": {
 526               "type": "boolean",
 527               "required": false,
 528               "default": "false",
 529               "description": "Show collection even if its `is_trashed` attribute is true.",
 530               "location": "query"
 531             }
 532           },
 533           "parameterOrder": [
 534             "uuid"
 535           ],
 536           "response": {
 537             "$ref": "Collection"
 538           },
 539           "scopes": [
 540             "https://api.arvados.org/auth/arvados",
 541             "https://api.arvados.org/auth/arvados.readonly"
 542           ]
 543         },
 544         "list": {
 545           "id": "arvados.collections.list",
 546           "path": "collections",
 547           "httpMethod": "GET",
 548           "description": "Retrieve a CollectionList.",
 549           "parameters": {
 550             "filters": {
 551               "type": "array",
 552               "required": false,
 553               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
 554               "location": "query"
 555             },
 556             "where": {
 557               "type": "object",
 558               "required": false,
 559               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
 560               "location": "query"
 561             },
 562             "order": {
 563               "type": "array",
 564               "required": false,
 565               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
 566               "location": "query"
 567             },
 568             "select": {
 569               "type": "array",
 570               "description": "An array of names of attributes to return from each matching object.",
 571               "required": false,
 572               "location": "query"
 573             },
 574             "distinct": {
 575               "type": "boolean",
 576               "required": false,
 577               "default": "false",
 578               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
 579               "location": "query"
 580             },
 581             "limit": {
 582               "type": "integer",
 583               "required": false,
 584               "default": "100",
 585               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
 586               "location": "query"
 587             },
 588             "offset": {
 589               "type": "integer",
 590               "required": false,
 591               "default": "0",
 592               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
 593               "location": "query"
 594             },
 595             "count": {
 596               "type": "string",
 597               "required": false,
 598               "default": "exact",
 599               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
 600               "location": "query"
 601             },
 602             "cluster_id": {
 603               "type": "string",
 604               "description": "Cluster ID of a federated cluster to return objects from",
 605               "location": "query",
 606               "required": false
 607             },
 608             "bypass_federation": {
 609               "type": "boolean",
 610               "required": false,
 611               "default": "false",
 612               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
 613               "location": "query"
 614             },
 615             "include_trash": {
 616               "type": "boolean",
 617               "required": false,
 618               "default": "false",
 619               "description": "Include collections whose `is_trashed` attribute is true.",
 620               "location": "query"
 621             },
 622             "include_old_versions": {
 623               "type": "boolean",
 624               "required": false,
 625               "default": "false",
 626               "description": "Include past collection versions.",
 627               "location": "query"
 628             }
 629           },
 630           "response": {
 631             "$ref": "CollectionList"
 632           },
 633           "scopes": [
 634             "https://api.arvados.org/auth/arvados",
 635             "https://api.arvados.org/auth/arvados.readonly"
 636           ]
 637         },
 638         "create": {
 639           "id": "arvados.collections.create",
 640           "path": "collections",
 641           "httpMethod": "POST",
 642           "description": "Create a new Collection.",
 643           "parameters": {
 644             "select": {
 645               "type": "array",
 646               "description": "An array of names of attributes to return in the response.",
 647               "required": false,
 648               "location": "query"
 649             },
 650             "ensure_unique_name": {
 651               "type": "boolean",
 652               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
 653               "location": "query",
 654               "required": false,
 655               "default": "false"
 656             },
 657             "cluster_id": {
 658               "type": "string",
 659               "description": "Cluster ID of a federated cluster where this object should be created.",
 660               "location": "query",
 661               "required": false
 662             },
 663             "replace_files": {
 664               "type": "object",
 665               "description": "Add, delete, and replace files and directories with new content\nand/or content from other collections. Refer to the\n[replace_files reference][] for details.\n\n[replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files\n\n",
 666               "required": false,
 667               "location": "query",
 668               "properties": {},
 669               "additionalProperties": {
 670                 "type": "string"
 671               }
 672             }
 673           },
 674           "request": {
 675             "required": true,
 676             "properties": {
 677               "collection": {
 678                 "$ref": "Collection"
 679               }
 680             }
 681           },
 682           "response": {
 683             "$ref": "Collection"
 684           },
 685           "scopes": [
 686             "https://api.arvados.org/auth/arvados"
 687           ]
 688         },
 689         "update": {
 690           "id": "arvados.collections.update",
 691           "path": "collections/{uuid}",
 692           "httpMethod": "PUT",
 693           "description": "Update attributes of an existing Collection.",
 694           "parameters": {
 695             "uuid": {
 696               "type": "string",
 697               "description": "The UUID of the Collection to update.",
 698               "required": true,
 699               "location": "path"
 700             },
 701             "select": {
 702               "type": "array",
 703               "description": "An array of names of attributes to return in the response.",
 704               "required": false,
 705               "location": "query"
 706             },
 707             "replace_files": {
 708               "type": "object",
 709               "description": "Add, delete, and replace files and directories with new content\nand/or content from other collections. Refer to the\n[replace_files reference][] for details.\n\n[replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files\n\n",
 710               "required": false,
 711               "location": "query",
 712               "properties": {},
 713               "additionalProperties": {
 714                 "type": "string"
 715               }
 716             }
 717           },
 718           "request": {
 719             "required": true,
 720             "properties": {
 721               "collection": {
 722                 "$ref": "Collection"
 723               }
 724             }
 725           },
 726           "response": {
 727             "$ref": "Collection"
 728           },
 729           "scopes": [
 730             "https://api.arvados.org/auth/arvados"
 731           ]
 732         },
 733         "delete": {
 734           "id": "arvados.collections.delete",
 735           "path": "collections/{uuid}",
 736           "httpMethod": "DELETE",
 737           "description": "Delete an existing Collection.",
 738           "parameters": {
 739             "uuid": {
 740               "type": "string",
 741               "description": "The UUID of the Collection to delete.",
 742               "required": true,
 743               "location": "path"
 744             }
 745           },
 746           "response": {
 747             "$ref": "Collection"
 748           },
 749           "scopes": [
 750             "https://api.arvados.org/auth/arvados"
 751           ]
 752         },
 753         "provenance": {
 754           "id": "arvados.collections.provenance",
 755           "path": "collections/{uuid}/provenance",
 756           "httpMethod": "GET",
 757           "description": "Detail the provenance of a given collection.",
 758           "parameters": {
 759             "uuid": {
 760               "type": "string",
 761               "description": "The UUID of the Collection to query.",
 762               "required": true,
 763               "location": "path"
 764             }
 765           },
 766           "response": {
 767             "$ref": "Collection"
 768           },
 769           "scopes": [
 770             "https://api.arvados.org/auth/arvados"
 771           ]
 772         },
 773         "used_by": {
 774           "id": "arvados.collections.used_by",
 775           "path": "collections/{uuid}/used_by",
 776           "httpMethod": "GET",
 777           "description": "Detail where a given collection has been used.",
 778           "parameters": {
 779             "uuid": {
 780               "type": "string",
 781               "description": "The UUID of the Collection to query.",
 782               "required": true,
 783               "location": "path"
 784             }
 785           },
 786           "response": {
 787             "$ref": "Collection"
 788           },
 789           "scopes": [
 790             "https://api.arvados.org/auth/arvados"
 791           ]
 792         },
 793         "trash": {
 794           "id": "arvados.collections.trash",
 795           "path": "collections/{uuid}/trash",
 796           "httpMethod": "POST",
 797           "description": "Trash a collection.",
 798           "parameters": {
 799             "uuid": {
 800               "type": "string",
 801               "description": "The UUID of the Collection to update.",
 802               "required": true,
 803               "location": "path"
 804             }
 805           },
 806           "response": {
 807             "$ref": "Collection"
 808           },
 809           "scopes": [
 810             "https://api.arvados.org/auth/arvados"
 811           ]
 812         },
 813         "untrash": {
 814           "id": "arvados.collections.untrash",
 815           "path": "collections/{uuid}/untrash",
 816           "httpMethod": "POST",
 817           "description": "Untrash a collection.",
 818           "parameters": {
 819             "uuid": {
 820               "type": "string",
 821               "description": "The UUID of the Collection to update.",
 822               "required": true,
 823               "location": "path"
 824             }
 825           },
 826           "response": {
 827             "$ref": "Collection"
 828           },
 829           "scopes": [
 830             "https://api.arvados.org/auth/arvados"
 831           ]
 832         }
 833       }
 834     },
 835     "computed_permissions": {
 836       "methods": {
 837         "list": {
 838           "id": "arvados.computed_permissions.list",
 839           "path": "computed_permissions",
 840           "httpMethod": "GET",
 841           "description": "Retrieve a ComputedPermissionList.",
 842           "parameters": {
 843             "filters": {
 844               "type": "array",
 845               "required": false,
 846               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
 847               "location": "query"
 848             },
 849             "where": {
 850               "type": "object",
 851               "required": false,
 852               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
 853               "location": "query"
 854             },
 855             "order": {
 856               "type": "array",
 857               "required": false,
 858               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
 859               "location": "query"
 860             },
 861             "select": {
 862               "type": "array",
 863               "description": "An array of names of attributes to return from each matching object.",
 864               "required": false,
 865               "location": "query"
 866             },
 867             "distinct": {
 868               "type": "boolean",
 869               "required": false,
 870               "default": "false",
 871               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
 872               "location": "query"
 873             },
 874             "limit": {
 875               "type": "integer",
 876               "required": false,
 877               "default": "100",
 878               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
 879               "location": "query"
 880             },
 881             "count": {
 882               "type": "string",
 883               "required": false,
 884               "default": "exact",
 885               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
 886               "location": "query"
 887             }
 888           },
 889           "response": {
 890             "$ref": "ComputedPermissionList"
 891           },
 892           "scopes": [
 893             "https://api.arvados.org/auth/arvados",
 894             "https://api.arvados.org/auth/arvados.readonly"
 895           ]
 896         }
 897       }
 898     },
 899     "containers": {
 900       "methods": {
 901         "get": {
 902           "id": "arvados.containers.get",
 903           "path": "containers/{uuid}",
 904           "httpMethod": "GET",
 905           "description": "Get a Container record by UUID.",
 906           "parameters": {
 907             "uuid": {
 908               "type": "string",
 909               "description": "The UUID of the Container to return.",
 910               "required": true,
 911               "location": "path"
 912             },
 913             "select": {
 914               "type": "array",
 915               "description": "An array of names of attributes to return in the response.",
 916               "required": false,
 917               "location": "query"
 918             }
 919           },
 920           "parameterOrder": [
 921             "uuid"
 922           ],
 923           "response": {
 924             "$ref": "Container"
 925           },
 926           "scopes": [
 927             "https://api.arvados.org/auth/arvados",
 928             "https://api.arvados.org/auth/arvados.readonly"
 929           ]
 930         },
 931         "list": {
 932           "id": "arvados.containers.list",
 933           "path": "containers",
 934           "httpMethod": "GET",
 935           "description": "Retrieve a ContainerList.",
 936           "parameters": {
 937             "filters": {
 938               "type": "array",
 939               "required": false,
 940               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
 941               "location": "query"
 942             },
 943             "where": {
 944               "type": "object",
 945               "required": false,
 946               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
 947               "location": "query"
 948             },
 949             "order": {
 950               "type": "array",
 951               "required": false,
 952               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
 953               "location": "query"
 954             },
 955             "select": {
 956               "type": "array",
 957               "description": "An array of names of attributes to return from each matching object.",
 958               "required": false,
 959               "location": "query"
 960             },
 961             "distinct": {
 962               "type": "boolean",
 963               "required": false,
 964               "default": "false",
 965               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
 966               "location": "query"
 967             },
 968             "limit": {
 969               "type": "integer",
 970               "required": false,
 971               "default": "100",
 972               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
 973               "location": "query"
 974             },
 975             "offset": {
 976               "type": "integer",
 977               "required": false,
 978               "default": "0",
 979               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
 980               "location": "query"
 981             },
 982             "count": {
 983               "type": "string",
 984               "required": false,
 985               "default": "exact",
 986               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
 987               "location": "query"
 988             },
 989             "cluster_id": {
 990               "type": "string",
 991               "description": "Cluster ID of a federated cluster to return objects from",
 992               "location": "query",
 993               "required": false
 994             },
 995             "bypass_federation": {
 996               "type": "boolean",
 997               "required": false,
 998               "default": "false",
 999               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
1000               "location": "query"
1001             }
1002           },
1003           "response": {
1004             "$ref": "ContainerList"
1005           },
1006           "scopes": [
1007             "https://api.arvados.org/auth/arvados",
1008             "https://api.arvados.org/auth/arvados.readonly"
1009           ]
1010         },
1011         "create": {
1012           "id": "arvados.containers.create",
1013           "path": "containers",
1014           "httpMethod": "POST",
1015           "description": "Create a new Container.",
1016           "parameters": {
1017             "select": {
1018               "type": "array",
1019               "description": "An array of names of attributes to return in the response.",
1020               "required": false,
1021               "location": "query"
1022             },
1023             "ensure_unique_name": {
1024               "type": "boolean",
1025               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
1026               "location": "query",
1027               "required": false,
1028               "default": "false"
1029             },
1030             "cluster_id": {
1031               "type": "string",
1032               "description": "Cluster ID of a federated cluster where this object should be created.",
1033               "location": "query",
1034               "required": false
1035             }
1036           },
1037           "request": {
1038             "required": true,
1039             "properties": {
1040               "container": {
1041                 "$ref": "Container"
1042               }
1043             }
1044           },
1045           "response": {
1046             "$ref": "Container"
1047           },
1048           "scopes": [
1049             "https://api.arvados.org/auth/arvados"
1050           ]
1051         },
1052         "update": {
1053           "id": "arvados.containers.update",
1054           "path": "containers/{uuid}",
1055           "httpMethod": "PUT",
1056           "description": "Update attributes of an existing Container.",
1057           "parameters": {
1058             "uuid": {
1059               "type": "string",
1060               "description": "The UUID of the Container to update.",
1061               "required": true,
1062               "location": "path"
1063             },
1064             "select": {
1065               "type": "array",
1066               "description": "An array of names of attributes to return in the response.",
1067               "required": false,
1068               "location": "query"
1069             }
1070           },
1071           "request": {
1072             "required": true,
1073             "properties": {
1074               "container": {
1075                 "$ref": "Container"
1076               }
1077             }
1078           },
1079           "response": {
1080             "$ref": "Container"
1081           },
1082           "scopes": [
1083             "https://api.arvados.org/auth/arvados"
1084           ]
1085         },
1086         "delete": {
1087           "id": "arvados.containers.delete",
1088           "path": "containers/{uuid}",
1089           "httpMethod": "DELETE",
1090           "description": "Delete an existing Container.",
1091           "parameters": {
1092             "uuid": {
1093               "type": "string",
1094               "description": "The UUID of the Container to delete.",
1095               "required": true,
1096               "location": "path"
1097             }
1098           },
1099           "response": {
1100             "$ref": "Container"
1101           },
1102           "scopes": [
1103             "https://api.arvados.org/auth/arvados"
1104           ]
1105         },
1106         "auth": {
1107           "id": "arvados.containers.auth",
1108           "path": "containers/{uuid}/auth",
1109           "httpMethod": "GET",
1110           "description": "Get the API client authorization token associated with this container.",
1111           "parameters": {
1112             "uuid": {
1113               "type": "string",
1114               "description": "The UUID of the Container to query.",
1115               "required": true,
1116               "location": "path"
1117             }
1118           },
1119           "response": {
1120             "$ref": "Container"
1121           },
1122           "scopes": [
1123             "https://api.arvados.org/auth/arvados"
1124           ]
1125         },
1126         "lock": {
1127           "id": "arvados.containers.lock",
1128           "path": "containers/{uuid}/lock",
1129           "httpMethod": "POST",
1130           "description": "Lock a container (for a dispatcher to begin running it).",
1131           "parameters": {
1132             "uuid": {
1133               "type": "string",
1134               "description": "The UUID of the Container to update.",
1135               "required": true,
1136               "location": "path"
1137             }
1138           },
1139           "response": {
1140             "$ref": "Container"
1141           },
1142           "scopes": [
1143             "https://api.arvados.org/auth/arvados"
1144           ]
1145         },
1146         "unlock": {
1147           "id": "arvados.containers.unlock",
1148           "path": "containers/{uuid}/unlock",
1149           "httpMethod": "POST",
1150           "description": "Unlock a container (for a dispatcher to stop running it).",
1151           "parameters": {
1152             "uuid": {
1153               "type": "string",
1154               "description": "The UUID of the Container to update.",
1155               "required": true,
1156               "location": "path"
1157             }
1158           },
1159           "response": {
1160             "$ref": "Container"
1161           },
1162           "scopes": [
1163             "https://api.arvados.org/auth/arvados"
1164           ]
1165         },
1166         "update_priority": {
1167           "id": "arvados.containers.update_priority",
1168           "path": "containers/{uuid}/update_priority",
1169           "httpMethod": "POST",
1170           "description": "Recalculate and return the priority of a given container.",
1171           "parameters": {
1172             "uuid": {
1173               "type": "string",
1174               "description": "The UUID of the Container to update.",
1175               "required": true,
1176               "location": "path"
1177             }
1178           },
1179           "response": {
1180             "$ref": "Container"
1181           },
1182           "scopes": [
1183             "https://api.arvados.org/auth/arvados"
1184           ]
1185         },
1186         "secret_mounts": {
1187           "id": "arvados.containers.secret_mounts",
1188           "path": "containers/{uuid}/secret_mounts",
1189           "httpMethod": "GET",
1190           "description": "Return secret mount information for the container associated with the API token authorizing this request.",
1191           "parameters": {
1192             "uuid": {
1193               "type": "string",
1194               "description": "The UUID of the Container to query.",
1195               "required": true,
1196               "location": "path"
1197             }
1198           },
1199           "response": {
1200             "$ref": "Container"
1201           },
1202           "scopes": [
1203             "https://api.arvados.org/auth/arvados"
1204           ]
1205         },
1206         "current": {
1207           "id": "arvados.containers.current",
1208           "path": "containers/current",
1209           "httpMethod": "GET",
1210           "description": "Return the container record associated with the API token authorizing this request.",
1211           "parameters": {},
1212           "response": {
1213             "$ref": "Container"
1214           },
1215           "scopes": [
1216             "https://api.arvados.org/auth/arvados"
1217           ]
1218         }
1219       }
1220     },
1221     "container_requests": {
1222       "methods": {
1223         "get": {
1224           "id": "arvados.container_requests.get",
1225           "path": "container_requests/{uuid}",
1226           "httpMethod": "GET",
1227           "description": "Get a ContainerRequest record by UUID.",
1228           "parameters": {
1229             "uuid": {
1230               "type": "string",
1231               "description": "The UUID of the ContainerRequest to return.",
1232               "required": true,
1233               "location": "path"
1234             },
1235             "select": {
1236               "type": "array",
1237               "description": "An array of names of attributes to return in the response.",
1238               "required": false,
1239               "location": "query"
1240             },
1241             "include_trash": {
1242               "type": "boolean",
1243               "required": false,
1244               "default": "false",
1245               "description": "Show container request even if its owner project is trashed.",
1246               "location": "query"
1247             }
1248           },
1249           "parameterOrder": [
1250             "uuid"
1251           ],
1252           "response": {
1253             "$ref": "ContainerRequest"
1254           },
1255           "scopes": [
1256             "https://api.arvados.org/auth/arvados",
1257             "https://api.arvados.org/auth/arvados.readonly"
1258           ]
1259         },
1260         "list": {
1261           "id": "arvados.container_requests.list",
1262           "path": "container_requests",
1263           "httpMethod": "GET",
1264           "description": "Retrieve a ContainerRequestList.",
1265           "parameters": {
1266             "filters": {
1267               "type": "array",
1268               "required": false,
1269               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
1270               "location": "query"
1271             },
1272             "where": {
1273               "type": "object",
1274               "required": false,
1275               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
1276               "location": "query"
1277             },
1278             "order": {
1279               "type": "array",
1280               "required": false,
1281               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
1282               "location": "query"
1283             },
1284             "select": {
1285               "type": "array",
1286               "description": "An array of names of attributes to return from each matching object.",
1287               "required": false,
1288               "location": "query"
1289             },
1290             "distinct": {
1291               "type": "boolean",
1292               "required": false,
1293               "default": "false",
1294               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
1295               "location": "query"
1296             },
1297             "limit": {
1298               "type": "integer",
1299               "required": false,
1300               "default": "100",
1301               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
1302               "location": "query"
1303             },
1304             "offset": {
1305               "type": "integer",
1306               "required": false,
1307               "default": "0",
1308               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
1309               "location": "query"
1310             },
1311             "count": {
1312               "type": "string",
1313               "required": false,
1314               "default": "exact",
1315               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
1316               "location": "query"
1317             },
1318             "cluster_id": {
1319               "type": "string",
1320               "description": "Cluster ID of a federated cluster to return objects from",
1321               "location": "query",
1322               "required": false
1323             },
1324             "bypass_federation": {
1325               "type": "boolean",
1326               "required": false,
1327               "default": "false",
1328               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
1329               "location": "query"
1330             },
1331             "include_trash": {
1332               "type": "boolean",
1333               "required": false,
1334               "default": "false",
1335               "description": "Include container requests whose owner project is trashed.",
1336               "location": "query"
1337             }
1338           },
1339           "response": {
1340             "$ref": "ContainerRequestList"
1341           },
1342           "scopes": [
1343             "https://api.arvados.org/auth/arvados",
1344             "https://api.arvados.org/auth/arvados.readonly"
1345           ]
1346         },
1347         "create": {
1348           "id": "arvados.container_requests.create",
1349           "path": "container_requests",
1350           "httpMethod": "POST",
1351           "description": "Create a new ContainerRequest.",
1352           "parameters": {
1353             "select": {
1354               "type": "array",
1355               "description": "An array of names of attributes to return in the response.",
1356               "required": false,
1357               "location": "query"
1358             },
1359             "ensure_unique_name": {
1360               "type": "boolean",
1361               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
1362               "location": "query",
1363               "required": false,
1364               "default": "false"
1365             },
1366             "cluster_id": {
1367               "type": "string",
1368               "description": "Cluster ID of a federated cluster where this object should be created.",
1369               "location": "query",
1370               "required": false
1371             }
1372           },
1373           "request": {
1374             "required": true,
1375             "properties": {
1376               "container_request": {
1377                 "$ref": "ContainerRequest"
1378               }
1379             }
1380           },
1381           "response": {
1382             "$ref": "ContainerRequest"
1383           },
1384           "scopes": [
1385             "https://api.arvados.org/auth/arvados"
1386           ]
1387         },
1388         "update": {
1389           "id": "arvados.container_requests.update",
1390           "path": "container_requests/{uuid}",
1391           "httpMethod": "PUT",
1392           "description": "Update attributes of an existing ContainerRequest.",
1393           "parameters": {
1394             "uuid": {
1395               "type": "string",
1396               "description": "The UUID of the ContainerRequest to update.",
1397               "required": true,
1398               "location": "path"
1399             },
1400             "select": {
1401               "type": "array",
1402               "description": "An array of names of attributes to return in the response.",
1403               "required": false,
1404               "location": "query"
1405             }
1406           },
1407           "request": {
1408             "required": true,
1409             "properties": {
1410               "container_request": {
1411                 "$ref": "ContainerRequest"
1412               }
1413             }
1414           },
1415           "response": {
1416             "$ref": "ContainerRequest"
1417           },
1418           "scopes": [
1419             "https://api.arvados.org/auth/arvados"
1420           ]
1421         },
1422         "delete": {
1423           "id": "arvados.container_requests.delete",
1424           "path": "container_requests/{uuid}",
1425           "httpMethod": "DELETE",
1426           "description": "Delete an existing ContainerRequest.",
1427           "parameters": {
1428             "uuid": {
1429               "type": "string",
1430               "description": "The UUID of the ContainerRequest to delete.",
1431               "required": true,
1432               "location": "path"
1433             }
1434           },
1435           "response": {
1436             "$ref": "ContainerRequest"
1437           },
1438           "scopes": [
1439             "https://api.arvados.org/auth/arvados"
1440           ]
1441         },
1442         "container_status": {
1443           "id": "arvados.container_requests.container_status",
1444           "path": "container_requests/{uuid}/container_status",
1445           "httpMethod": "GET",
1446           "description": "Return scheduling details for a container request.",
1447           "parameters": {
1448             "uuid": {
1449               "type": "string",
1450               "required": true,
1451               "description": "The UUID of the container request to query.",
1452               "location": "query"
1453             }
1454           },
1455           "response": {
1456             "$ref": "ContainerRequest"
1457           },
1458           "scopes": [
1459             "https://api.arvados.org/auth/arvados"
1460           ]
1461         }
1462       }
1463     },
1464     "groups": {
1465       "methods": {
1466         "get": {
1467           "id": "arvados.groups.get",
1468           "path": "groups/{uuid}",
1469           "httpMethod": "GET",
1470           "description": "Get a Group record by UUID.",
1471           "parameters": {
1472             "uuid": {
1473               "type": "string",
1474               "description": "The UUID of the Group to return.",
1475               "required": true,
1476               "location": "path"
1477             },
1478             "select": {
1479               "type": "array",
1480               "description": "An array of names of attributes to return in the response.",
1481               "required": false,
1482               "location": "query"
1483             },
1484             "include_trash": {
1485               "type": "boolean",
1486               "required": false,
1487               "default": "false",
1488               "description": "Return group/project even if its `is_trashed` attribute is true.",
1489               "location": "query"
1490             }
1491           },
1492           "parameterOrder": [
1493             "uuid"
1494           ],
1495           "response": {
1496             "$ref": "Group"
1497           },
1498           "scopes": [
1499             "https://api.arvados.org/auth/arvados",
1500             "https://api.arvados.org/auth/arvados.readonly"
1501           ]
1502         },
1503         "list": {
1504           "id": "arvados.groups.list",
1505           "path": "groups",
1506           "httpMethod": "GET",
1507           "description": "Retrieve a GroupList.",
1508           "parameters": {
1509             "filters": {
1510               "type": "array",
1511               "required": false,
1512               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
1513               "location": "query"
1514             },
1515             "where": {
1516               "type": "object",
1517               "required": false,
1518               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
1519               "location": "query"
1520             },
1521             "order": {
1522               "type": "array",
1523               "required": false,
1524               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
1525               "location": "query"
1526             },
1527             "select": {
1528               "type": "array",
1529               "description": "An array of names of attributes to return from each matching object.",
1530               "required": false,
1531               "location": "query"
1532             },
1533             "distinct": {
1534               "type": "boolean",
1535               "required": false,
1536               "default": "false",
1537               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
1538               "location": "query"
1539             },
1540             "limit": {
1541               "type": "integer",
1542               "required": false,
1543               "default": "100",
1544               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
1545               "location": "query"
1546             },
1547             "offset": {
1548               "type": "integer",
1549               "required": false,
1550               "default": "0",
1551               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
1552               "location": "query"
1553             },
1554             "count": {
1555               "type": "string",
1556               "required": false,
1557               "default": "exact",
1558               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
1559               "location": "query"
1560             },
1561             "cluster_id": {
1562               "type": "string",
1563               "description": "Cluster ID of a federated cluster to return objects from",
1564               "location": "query",
1565               "required": false
1566             },
1567             "bypass_federation": {
1568               "type": "boolean",
1569               "required": false,
1570               "default": "false",
1571               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
1572               "location": "query"
1573             },
1574             "include_trash": {
1575               "type": "boolean",
1576               "required": false,
1577               "default": "false",
1578               "description": "Include items whose `is_trashed` attribute is true.",
1579               "location": "query"
1580             }
1581           },
1582           "response": {
1583             "$ref": "GroupList"
1584           },
1585           "scopes": [
1586             "https://api.arvados.org/auth/arvados",
1587             "https://api.arvados.org/auth/arvados.readonly"
1588           ]
1589         },
1590         "create": {
1591           "id": "arvados.groups.create",
1592           "path": "groups",
1593           "httpMethod": "POST",
1594           "description": "Create a new Group.",
1595           "parameters": {
1596             "select": {
1597               "type": "array",
1598               "description": "An array of names of attributes to return in the response.",
1599               "required": false,
1600               "location": "query"
1601             },
1602             "ensure_unique_name": {
1603               "type": "boolean",
1604               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
1605               "location": "query",
1606               "required": false,
1607               "default": "false"
1608             },
1609             "cluster_id": {
1610               "type": "string",
1611               "description": "Cluster ID of a federated cluster where this object should be created.",
1612               "location": "query",
1613               "required": false
1614             },
1615             "async": {
1616               "required": false,
1617               "type": "boolean",
1618               "location": "query",
1619               "default": "false",
1620               "description": "If true, cluster permission will not be updated immediately, but instead at the next configured update interval."
1621             }
1622           },
1623           "request": {
1624             "required": true,
1625             "properties": {
1626               "group": {
1627                 "$ref": "Group"
1628               }
1629             }
1630           },
1631           "response": {
1632             "$ref": "Group"
1633           },
1634           "scopes": [
1635             "https://api.arvados.org/auth/arvados"
1636           ]
1637         },
1638         "update": {
1639           "id": "arvados.groups.update",
1640           "path": "groups/{uuid}",
1641           "httpMethod": "PUT",
1642           "description": "Update attributes of an existing Group.",
1643           "parameters": {
1644             "uuid": {
1645               "type": "string",
1646               "description": "The UUID of the Group to update.",
1647               "required": true,
1648               "location": "path"
1649             },
1650             "select": {
1651               "type": "array",
1652               "description": "An array of names of attributes to return in the response.",
1653               "required": false,
1654               "location": "query"
1655             },
1656             "async": {
1657               "required": false,
1658               "type": "boolean",
1659               "location": "query",
1660               "default": "false",
1661               "description": "If true, cluster permission will not be updated immediately, but instead at the next configured update interval."
1662             }
1663           },
1664           "request": {
1665             "required": true,
1666             "properties": {
1667               "group": {
1668                 "$ref": "Group"
1669               }
1670             }
1671           },
1672           "response": {
1673             "$ref": "Group"
1674           },
1675           "scopes": [
1676             "https://api.arvados.org/auth/arvados"
1677           ]
1678         },
1679         "delete": {
1680           "id": "arvados.groups.delete",
1681           "path": "groups/{uuid}",
1682           "httpMethod": "DELETE",
1683           "description": "Delete an existing Group.",
1684           "parameters": {
1685             "uuid": {
1686               "type": "string",
1687               "description": "The UUID of the Group to delete.",
1688               "required": true,
1689               "location": "path"
1690             }
1691           },
1692           "response": {
1693             "$ref": "Group"
1694           },
1695           "scopes": [
1696             "https://api.arvados.org/auth/arvados"
1697           ]
1698         },
1699         "contents": {
1700           "id": "arvados.groups.contents",
1701           "path": "groups/contents",
1702           "httpMethod": "GET",
1703           "description": "List objects that belong to a group.",
1704           "parameters": {
1705             "filters": {
1706               "type": "array",
1707               "required": false,
1708               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
1709               "location": "query"
1710             },
1711             "where": {
1712               "type": "object",
1713               "required": false,
1714               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
1715               "location": "query"
1716             },
1717             "order": {
1718               "type": "array",
1719               "required": false,
1720               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
1721               "location": "query"
1722             },
1723             "select": {
1724               "type": "array",
1725               "description": "An array of names of attributes to return from each matching object.",
1726               "required": false,
1727               "location": "query"
1728             },
1729             "distinct": {
1730               "type": "boolean",
1731               "required": false,
1732               "default": "false",
1733               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
1734               "location": "query"
1735             },
1736             "limit": {
1737               "type": "integer",
1738               "required": false,
1739               "default": "100",
1740               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
1741               "location": "query"
1742             },
1743             "offset": {
1744               "type": "integer",
1745               "required": false,
1746               "default": "0",
1747               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
1748               "location": "query"
1749             },
1750             "count": {
1751               "type": "string",
1752               "required": false,
1753               "default": "exact",
1754               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
1755               "location": "query"
1756             },
1757             "cluster_id": {
1758               "type": "string",
1759               "description": "Cluster ID of a federated cluster to return objects from",
1760               "location": "query",
1761               "required": false
1762             },
1763             "bypass_federation": {
1764               "type": "boolean",
1765               "required": false,
1766               "default": "false",
1767               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
1768               "location": "query"
1769             },
1770             "include_trash": {
1771               "type": "boolean",
1772               "required": false,
1773               "default": "false",
1774               "description": "Include items whose `is_trashed` attribute is true.",
1775               "location": "query"
1776             },
1777             "uuid": {
1778               "type": "string",
1779               "required": false,
1780               "default": "",
1781               "description": "If given, limit the listing to objects owned by the\nuser or group with this UUID.",
1782               "location": "query"
1783             },
1784             "recursive": {
1785               "type": "boolean",
1786               "required": false,
1787               "default": "false",
1788               "description": "If true, include contents from child groups recursively.",
1789               "location": "query"
1790             },
1791             "include": {
1792               "type": "array",
1793               "required": false,
1794               "description": "An array of referenced objects to include in the `included` field of the response. Supported values in the array are:\n\n  * `\"container_uuid\"`\n  * `\"owner_uuid\"`\n\n",
1795               "location": "query"
1796             },
1797             "include_old_versions": {
1798               "type": "boolean",
1799               "required": false,
1800               "default": "false",
1801               "description": "If true, include past versions of collections in the listing.",
1802               "location": "query"
1803             },
1804             "exclude_home_project": {
1805               "type": "boolean",
1806               "required": false,
1807               "default": "false",
1808               "description": "If true, exclude contents of the user's home project from the listing.\nCalling this method with this flag set is how clients enumerate objects shared\nwith the current user.",
1809               "location": "query"
1810             }
1811           },
1812           "response": {
1813             "$ref": "Group"
1814           },
1815           "scopes": [
1816             "https://api.arvados.org/auth/arvados"
1817           ]
1818         },
1819         "shared": {
1820           "id": "arvados.groups.shared",
1821           "path": "groups/shared",
1822           "httpMethod": "GET",
1823           "description": "List groups that the current user can access via permission links.",
1824           "parameters": {
1825             "filters": {
1826               "type": "array",
1827               "required": false,
1828               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
1829               "location": "query"
1830             },
1831             "where": {
1832               "type": "object",
1833               "required": false,
1834               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
1835               "location": "query"
1836             },
1837             "order": {
1838               "type": "array",
1839               "required": false,
1840               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
1841               "location": "query"
1842             },
1843             "select": {
1844               "type": "array",
1845               "description": "An array of names of attributes to return from each matching object.",
1846               "required": false,
1847               "location": "query"
1848             },
1849             "distinct": {
1850               "type": "boolean",
1851               "required": false,
1852               "default": "false",
1853               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
1854               "location": "query"
1855             },
1856             "limit": {
1857               "type": "integer",
1858               "required": false,
1859               "default": "100",
1860               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
1861               "location": "query"
1862             },
1863             "offset": {
1864               "type": "integer",
1865               "required": false,
1866               "default": "0",
1867               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
1868               "location": "query"
1869             },
1870             "count": {
1871               "type": "string",
1872               "required": false,
1873               "default": "exact",
1874               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
1875               "location": "query"
1876             },
1877             "cluster_id": {
1878               "type": "string",
1879               "description": "Cluster ID of a federated cluster to return objects from",
1880               "location": "query",
1881               "required": false
1882             },
1883             "bypass_federation": {
1884               "type": "boolean",
1885               "required": false,
1886               "default": "false",
1887               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
1888               "location": "query"
1889             },
1890             "include_trash": {
1891               "type": "boolean",
1892               "required": false,
1893               "default": "false",
1894               "description": "Include items whose `is_trashed` attribute is true.",
1895               "location": "query"
1896             },
1897             "include": {
1898               "type": "string",
1899               "required": false,
1900               "description": "A string naming referenced objects to include in the `included` field of the response. Supported values are:\n\n  * `\"owner_uuid\"`\n\n",
1901               "location": "query"
1902             }
1903           },
1904           "response": {
1905             "$ref": "Group"
1906           },
1907           "scopes": [
1908             "https://api.arvados.org/auth/arvados"
1909           ]
1910         },
1911         "trash": {
1912           "id": "arvados.groups.trash",
1913           "path": "groups/{uuid}/trash",
1914           "httpMethod": "POST",
1915           "description": "Trash a group.",
1916           "parameters": {
1917             "uuid": {
1918               "type": "string",
1919               "description": "The UUID of the Group to update.",
1920               "required": true,
1921               "location": "path"
1922             }
1923           },
1924           "response": {
1925             "$ref": "Group"
1926           },
1927           "scopes": [
1928             "https://api.arvados.org/auth/arvados"
1929           ]
1930         },
1931         "untrash": {
1932           "id": "arvados.groups.untrash",
1933           "path": "groups/{uuid}/untrash",
1934           "httpMethod": "POST",
1935           "description": "Untrash a group.",
1936           "parameters": {
1937             "uuid": {
1938               "type": "string",
1939               "description": "The UUID of the Group to update.",
1940               "required": true,
1941               "location": "path"
1942             }
1943           },
1944           "response": {
1945             "$ref": "Group"
1946           },
1947           "scopes": [
1948             "https://api.arvados.org/auth/arvados"
1949           ]
1950         }
1951       }
1952     },
1953     "keep_services": {
1954       "methods": {
1955         "get": {
1956           "id": "arvados.keep_services.get",
1957           "path": "keep_services/{uuid}",
1958           "httpMethod": "GET",
1959           "description": "Get a KeepService record by UUID.",
1960           "parameters": {
1961             "uuid": {
1962               "type": "string",
1963               "description": "The UUID of the KeepService to return.",
1964               "required": true,
1965               "location": "path"
1966             },
1967             "select": {
1968               "type": "array",
1969               "description": "An array of names of attributes to return in the response.",
1970               "required": false,
1971               "location": "query"
1972             }
1973           },
1974           "parameterOrder": [
1975             "uuid"
1976           ],
1977           "response": {
1978             "$ref": "KeepService"
1979           },
1980           "scopes": [
1981             "https://api.arvados.org/auth/arvados",
1982             "https://api.arvados.org/auth/arvados.readonly"
1983           ]
1984         },
1985         "list": {
1986           "id": "arvados.keep_services.list",
1987           "path": "keep_services",
1988           "httpMethod": "GET",
1989           "description": "Retrieve a KeepServiceList.",
1990           "parameters": {
1991             "filters": {
1992               "type": "array",
1993               "required": false,
1994               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
1995               "location": "query"
1996             },
1997             "where": {
1998               "type": "object",
1999               "required": false,
2000               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
2001               "location": "query"
2002             },
2003             "order": {
2004               "type": "array",
2005               "required": false,
2006               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
2007               "location": "query"
2008             },
2009             "select": {
2010               "type": "array",
2011               "description": "An array of names of attributes to return from each matching object.",
2012               "required": false,
2013               "location": "query"
2014             },
2015             "distinct": {
2016               "type": "boolean",
2017               "required": false,
2018               "default": "false",
2019               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
2020               "location": "query"
2021             },
2022             "limit": {
2023               "type": "integer",
2024               "required": false,
2025               "default": "100",
2026               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
2027               "location": "query"
2028             },
2029             "offset": {
2030               "type": "integer",
2031               "required": false,
2032               "default": "0",
2033               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
2034               "location": "query"
2035             },
2036             "count": {
2037               "type": "string",
2038               "required": false,
2039               "default": "exact",
2040               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
2041               "location": "query"
2042             },
2043             "cluster_id": {
2044               "type": "string",
2045               "description": "Cluster ID of a federated cluster to return objects from",
2046               "location": "query",
2047               "required": false
2048             },
2049             "bypass_federation": {
2050               "type": "boolean",
2051               "required": false,
2052               "default": "false",
2053               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
2054               "location": "query"
2055             }
2056           },
2057           "response": {
2058             "$ref": "KeepServiceList"
2059           },
2060           "scopes": [
2061             "https://api.arvados.org/auth/arvados",
2062             "https://api.arvados.org/auth/arvados.readonly"
2063           ]
2064         },
2065         "create": {
2066           "id": "arvados.keep_services.create",
2067           "path": "keep_services",
2068           "httpMethod": "POST",
2069           "description": "Create a new KeepService.",
2070           "parameters": {
2071             "select": {
2072               "type": "array",
2073               "description": "An array of names of attributes to return in the response.",
2074               "required": false,
2075               "location": "query"
2076             },
2077             "ensure_unique_name": {
2078               "type": "boolean",
2079               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
2080               "location": "query",
2081               "required": false,
2082               "default": "false"
2083             },
2084             "cluster_id": {
2085               "type": "string",
2086               "description": "Cluster ID of a federated cluster where this object should be created.",
2087               "location": "query",
2088               "required": false
2089             }
2090           },
2091           "request": {
2092             "required": true,
2093             "properties": {
2094               "keep_service": {
2095                 "$ref": "KeepService"
2096               }
2097             }
2098           },
2099           "response": {
2100             "$ref": "KeepService"
2101           },
2102           "scopes": [
2103             "https://api.arvados.org/auth/arvados"
2104           ]
2105         },
2106         "update": {
2107           "id": "arvados.keep_services.update",
2108           "path": "keep_services/{uuid}",
2109           "httpMethod": "PUT",
2110           "description": "Update attributes of an existing KeepService.",
2111           "parameters": {
2112             "uuid": {
2113               "type": "string",
2114               "description": "The UUID of the KeepService to update.",
2115               "required": true,
2116               "location": "path"
2117             },
2118             "select": {
2119               "type": "array",
2120               "description": "An array of names of attributes to return in the response.",
2121               "required": false,
2122               "location": "query"
2123             }
2124           },
2125           "request": {
2126             "required": true,
2127             "properties": {
2128               "keep_service": {
2129                 "$ref": "KeepService"
2130               }
2131             }
2132           },
2133           "response": {
2134             "$ref": "KeepService"
2135           },
2136           "scopes": [
2137             "https://api.arvados.org/auth/arvados"
2138           ]
2139         },
2140         "delete": {
2141           "id": "arvados.keep_services.delete",
2142           "path": "keep_services/{uuid}",
2143           "httpMethod": "DELETE",
2144           "description": "Delete an existing KeepService.",
2145           "parameters": {
2146             "uuid": {
2147               "type": "string",
2148               "description": "The UUID of the KeepService to delete.",
2149               "required": true,
2150               "location": "path"
2151             }
2152           },
2153           "response": {
2154             "$ref": "KeepService"
2155           },
2156           "scopes": [
2157             "https://api.arvados.org/auth/arvados"
2158           ]
2159         },
2160         "accessible": {
2161           "id": "arvados.keep_services.accessible",
2162           "path": "keep_services/accessible",
2163           "httpMethod": "GET",
2164           "description": "List Keep services that the current client can access.",
2165           "parameters": {},
2166           "response": {
2167             "$ref": "KeepService"
2168           },
2169           "scopes": [
2170             "https://api.arvados.org/auth/arvados"
2171           ]
2172         }
2173       }
2174     },
2175     "links": {
2176       "methods": {
2177         "get": {
2178           "id": "arvados.links.get",
2179           "path": "links/{uuid}",
2180           "httpMethod": "GET",
2181           "description": "Get a Link record by UUID.",
2182           "parameters": {
2183             "uuid": {
2184               "type": "string",
2185               "description": "The UUID of the Link to return.",
2186               "required": true,
2187               "location": "path"
2188             },
2189             "select": {
2190               "type": "array",
2191               "description": "An array of names of attributes to return in the response.",
2192               "required": false,
2193               "location": "query"
2194             }
2195           },
2196           "parameterOrder": [
2197             "uuid"
2198           ],
2199           "response": {
2200             "$ref": "Link"
2201           },
2202           "scopes": [
2203             "https://api.arvados.org/auth/arvados",
2204             "https://api.arvados.org/auth/arvados.readonly"
2205           ]
2206         },
2207         "list": {
2208           "id": "arvados.links.list",
2209           "path": "links",
2210           "httpMethod": "GET",
2211           "description": "Retrieve a LinkList.",
2212           "parameters": {
2213             "filters": {
2214               "type": "array",
2215               "required": false,
2216               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
2217               "location": "query"
2218             },
2219             "where": {
2220               "type": "object",
2221               "required": false,
2222               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
2223               "location": "query"
2224             },
2225             "order": {
2226               "type": "array",
2227               "required": false,
2228               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
2229               "location": "query"
2230             },
2231             "select": {
2232               "type": "array",
2233               "description": "An array of names of attributes to return from each matching object.",
2234               "required": false,
2235               "location": "query"
2236             },
2237             "distinct": {
2238               "type": "boolean",
2239               "required": false,
2240               "default": "false",
2241               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
2242               "location": "query"
2243             },
2244             "limit": {
2245               "type": "integer",
2246               "required": false,
2247               "default": "100",
2248               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
2249               "location": "query"
2250             },
2251             "offset": {
2252               "type": "integer",
2253               "required": false,
2254               "default": "0",
2255               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
2256               "location": "query"
2257             },
2258             "count": {
2259               "type": "string",
2260               "required": false,
2261               "default": "exact",
2262               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
2263               "location": "query"
2264             },
2265             "cluster_id": {
2266               "type": "string",
2267               "description": "Cluster ID of a federated cluster to return objects from",
2268               "location": "query",
2269               "required": false
2270             },
2271             "bypass_federation": {
2272               "type": "boolean",
2273               "required": false,
2274               "default": "false",
2275               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
2276               "location": "query"
2277             }
2278           },
2279           "response": {
2280             "$ref": "LinkList"
2281           },
2282           "scopes": [
2283             "https://api.arvados.org/auth/arvados",
2284             "https://api.arvados.org/auth/arvados.readonly"
2285           ]
2286         },
2287         "create": {
2288           "id": "arvados.links.create",
2289           "path": "links",
2290           "httpMethod": "POST",
2291           "description": "Create a new Link.",
2292           "parameters": {
2293             "select": {
2294               "type": "array",
2295               "description": "An array of names of attributes to return in the response.",
2296               "required": false,
2297               "location": "query"
2298             },
2299             "ensure_unique_name": {
2300               "type": "boolean",
2301               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
2302               "location": "query",
2303               "required": false,
2304               "default": "false"
2305             },
2306             "cluster_id": {
2307               "type": "string",
2308               "description": "Cluster ID of a federated cluster where this object should be created.",
2309               "location": "query",
2310               "required": false
2311             }
2312           },
2313           "request": {
2314             "required": true,
2315             "properties": {
2316               "link": {
2317                 "$ref": "Link"
2318               }
2319             }
2320           },
2321           "response": {
2322             "$ref": "Link"
2323           },
2324           "scopes": [
2325             "https://api.arvados.org/auth/arvados"
2326           ]
2327         },
2328         "update": {
2329           "id": "arvados.links.update",
2330           "path": "links/{uuid}",
2331           "httpMethod": "PUT",
2332           "description": "Update attributes of an existing Link.",
2333           "parameters": {
2334             "uuid": {
2335               "type": "string",
2336               "description": "The UUID of the Link to update.",
2337               "required": true,
2338               "location": "path"
2339             },
2340             "select": {
2341               "type": "array",
2342               "description": "An array of names of attributes to return in the response.",
2343               "required": false,
2344               "location": "query"
2345             }
2346           },
2347           "request": {
2348             "required": true,
2349             "properties": {
2350               "link": {
2351                 "$ref": "Link"
2352               }
2353             }
2354           },
2355           "response": {
2356             "$ref": "Link"
2357           },
2358           "scopes": [
2359             "https://api.arvados.org/auth/arvados"
2360           ]
2361         },
2362         "delete": {
2363           "id": "arvados.links.delete",
2364           "path": "links/{uuid}",
2365           "httpMethod": "DELETE",
2366           "description": "Delete an existing Link.",
2367           "parameters": {
2368             "uuid": {
2369               "type": "string",
2370               "description": "The UUID of the Link to delete.",
2371               "required": true,
2372               "location": "path"
2373             }
2374           },
2375           "response": {
2376             "$ref": "Link"
2377           },
2378           "scopes": [
2379             "https://api.arvados.org/auth/arvados"
2380           ]
2381         },
2382         "get_permissions": {
2383           "id": "arvados.links.get_permissions",
2384           "path": "permissions/{uuid}",
2385           "httpMethod": "GET",
2386           "description": "List permissions granted on an Arvados object.",
2387           "parameters": {
2388             "uuid": {
2389               "type": "string",
2390               "description": "The UUID of the Link to query.",
2391               "required": true,
2392               "location": "path"
2393             }
2394           },
2395           "response": {
2396             "$ref": "Link"
2397           },
2398           "scopes": [
2399             "https://api.arvados.org/auth/arvados"
2400           ]
2401         }
2402       }
2403     },
2404     "logs": {
2405       "methods": {
2406         "get": {
2407           "id": "arvados.logs.get",
2408           "path": "logs/{uuid}",
2409           "httpMethod": "GET",
2410           "description": "Get a Log record by UUID.",
2411           "parameters": {
2412             "uuid": {
2413               "type": "string",
2414               "description": "The UUID of the Log to return.",
2415               "required": true,
2416               "location": "path"
2417             },
2418             "select": {
2419               "type": "array",
2420               "description": "An array of names of attributes to return in the response.",
2421               "required": false,
2422               "location": "query"
2423             }
2424           },
2425           "parameterOrder": [
2426             "uuid"
2427           ],
2428           "response": {
2429             "$ref": "Log"
2430           },
2431           "scopes": [
2432             "https://api.arvados.org/auth/arvados",
2433             "https://api.arvados.org/auth/arvados.readonly"
2434           ]
2435         },
2436         "list": {
2437           "id": "arvados.logs.list",
2438           "path": "logs",
2439           "httpMethod": "GET",
2440           "description": "Retrieve a LogList.",
2441           "parameters": {
2442             "filters": {
2443               "type": "array",
2444               "required": false,
2445               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
2446               "location": "query"
2447             },
2448             "where": {
2449               "type": "object",
2450               "required": false,
2451               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
2452               "location": "query"
2453             },
2454             "order": {
2455               "type": "array",
2456               "required": false,
2457               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
2458               "location": "query"
2459             },
2460             "select": {
2461               "type": "array",
2462               "description": "An array of names of attributes to return from each matching object.",
2463               "required": false,
2464               "location": "query"
2465             },
2466             "distinct": {
2467               "type": "boolean",
2468               "required": false,
2469               "default": "false",
2470               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
2471               "location": "query"
2472             },
2473             "limit": {
2474               "type": "integer",
2475               "required": false,
2476               "default": "100",
2477               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
2478               "location": "query"
2479             },
2480             "offset": {
2481               "type": "integer",
2482               "required": false,
2483               "default": "0",
2484               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
2485               "location": "query"
2486             },
2487             "count": {
2488               "type": "string",
2489               "required": false,
2490               "default": "exact",
2491               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
2492               "location": "query"
2493             },
2494             "cluster_id": {
2495               "type": "string",
2496               "description": "Cluster ID of a federated cluster to return objects from",
2497               "location": "query",
2498               "required": false
2499             },
2500             "bypass_federation": {
2501               "type": "boolean",
2502               "required": false,
2503               "default": "false",
2504               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
2505               "location": "query"
2506             }
2507           },
2508           "response": {
2509             "$ref": "LogList"
2510           },
2511           "scopes": [
2512             "https://api.arvados.org/auth/arvados",
2513             "https://api.arvados.org/auth/arvados.readonly"
2514           ]
2515         },
2516         "create": {
2517           "id": "arvados.logs.create",
2518           "path": "logs",
2519           "httpMethod": "POST",
2520           "description": "Create a new Log.",
2521           "parameters": {
2522             "select": {
2523               "type": "array",
2524               "description": "An array of names of attributes to return in the response.",
2525               "required": false,
2526               "location": "query"
2527             },
2528             "ensure_unique_name": {
2529               "type": "boolean",
2530               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
2531               "location": "query",
2532               "required": false,
2533               "default": "false"
2534             },
2535             "cluster_id": {
2536               "type": "string",
2537               "description": "Cluster ID of a federated cluster where this object should be created.",
2538               "location": "query",
2539               "required": false
2540             }
2541           },
2542           "request": {
2543             "required": true,
2544             "properties": {
2545               "log": {
2546                 "$ref": "Log"
2547               }
2548             }
2549           },
2550           "response": {
2551             "$ref": "Log"
2552           },
2553           "scopes": [
2554             "https://api.arvados.org/auth/arvados"
2555           ]
2556         },
2557         "update": {
2558           "id": "arvados.logs.update",
2559           "path": "logs/{uuid}",
2560           "httpMethod": "PUT",
2561           "description": "Update attributes of an existing Log.",
2562           "parameters": {
2563             "uuid": {
2564               "type": "string",
2565               "description": "The UUID of the Log to update.",
2566               "required": true,
2567               "location": "path"
2568             },
2569             "select": {
2570               "type": "array",
2571               "description": "An array of names of attributes to return in the response.",
2572               "required": false,
2573               "location": "query"
2574             }
2575           },
2576           "request": {
2577             "required": true,
2578             "properties": {
2579               "log": {
2580                 "$ref": "Log"
2581               }
2582             }
2583           },
2584           "response": {
2585             "$ref": "Log"
2586           },
2587           "scopes": [
2588             "https://api.arvados.org/auth/arvados"
2589           ]
2590         },
2591         "delete": {
2592           "id": "arvados.logs.delete",
2593           "path": "logs/{uuid}",
2594           "httpMethod": "DELETE",
2595           "description": "Delete an existing Log.",
2596           "parameters": {
2597             "uuid": {
2598               "type": "string",
2599               "description": "The UUID of the Log to delete.",
2600               "required": true,
2601               "location": "path"
2602             }
2603           },
2604           "response": {
2605             "$ref": "Log"
2606           },
2607           "scopes": [
2608             "https://api.arvados.org/auth/arvados"
2609           ]
2610         }
2611       }
2612     },
2613     "users": {
2614       "methods": {
2615         "get": {
2616           "id": "arvados.users.get",
2617           "path": "users/{uuid}",
2618           "httpMethod": "GET",
2619           "description": "Get a User record by UUID.",
2620           "parameters": {
2621             "uuid": {
2622               "type": "string",
2623               "description": "The UUID of the User to return.",
2624               "required": true,
2625               "location": "path"
2626             },
2627             "select": {
2628               "type": "array",
2629               "description": "An array of names of attributes to return in the response.",
2630               "required": false,
2631               "location": "query"
2632             }
2633           },
2634           "parameterOrder": [
2635             "uuid"
2636           ],
2637           "response": {
2638             "$ref": "User"
2639           },
2640           "scopes": [
2641             "https://api.arvados.org/auth/arvados",
2642             "https://api.arvados.org/auth/arvados.readonly"
2643           ]
2644         },
2645         "list": {
2646           "id": "arvados.users.list",
2647           "path": "users",
2648           "httpMethod": "GET",
2649           "description": "Retrieve a UserList.",
2650           "parameters": {
2651             "filters": {
2652               "type": "array",
2653               "required": false,
2654               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
2655               "location": "query"
2656             },
2657             "where": {
2658               "type": "object",
2659               "required": false,
2660               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
2661               "location": "query"
2662             },
2663             "order": {
2664               "type": "array",
2665               "required": false,
2666               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
2667               "location": "query"
2668             },
2669             "select": {
2670               "type": "array",
2671               "description": "An array of names of attributes to return from each matching object.",
2672               "required": false,
2673               "location": "query"
2674             },
2675             "distinct": {
2676               "type": "boolean",
2677               "required": false,
2678               "default": "false",
2679               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
2680               "location": "query"
2681             },
2682             "limit": {
2683               "type": "integer",
2684               "required": false,
2685               "default": "100",
2686               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
2687               "location": "query"
2688             },
2689             "offset": {
2690               "type": "integer",
2691               "required": false,
2692               "default": "0",
2693               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
2694               "location": "query"
2695             },
2696             "count": {
2697               "type": "string",
2698               "required": false,
2699               "default": "exact",
2700               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
2701               "location": "query"
2702             },
2703             "cluster_id": {
2704               "type": "string",
2705               "description": "Cluster ID of a federated cluster to return objects from",
2706               "location": "query",
2707               "required": false
2708             },
2709             "bypass_federation": {
2710               "type": "boolean",
2711               "required": false,
2712               "default": "false",
2713               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
2714               "location": "query"
2715             }
2716           },
2717           "response": {
2718             "$ref": "UserList"
2719           },
2720           "scopes": [
2721             "https://api.arvados.org/auth/arvados",
2722             "https://api.arvados.org/auth/arvados.readonly"
2723           ]
2724         },
2725         "create": {
2726           "id": "arvados.users.create",
2727           "path": "users",
2728           "httpMethod": "POST",
2729           "description": "Create a new User.",
2730           "parameters": {
2731             "select": {
2732               "type": "array",
2733               "description": "An array of names of attributes to return in the response.",
2734               "required": false,
2735               "location": "query"
2736             },
2737             "ensure_unique_name": {
2738               "type": "boolean",
2739               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
2740               "location": "query",
2741               "required": false,
2742               "default": "false"
2743             },
2744             "cluster_id": {
2745               "type": "string",
2746               "description": "Cluster ID of a federated cluster where this object should be created.",
2747               "location": "query",
2748               "required": false
2749             }
2750           },
2751           "request": {
2752             "required": true,
2753             "properties": {
2754               "user": {
2755                 "$ref": "User"
2756               }
2757             }
2758           },
2759           "response": {
2760             "$ref": "User"
2761           },
2762           "scopes": [
2763             "https://api.arvados.org/auth/arvados"
2764           ]
2765         },
2766         "update": {
2767           "id": "arvados.users.update",
2768           "path": "users/{uuid}",
2769           "httpMethod": "PUT",
2770           "description": "Update attributes of an existing User.",
2771           "parameters": {
2772             "uuid": {
2773               "type": "string",
2774               "description": "The UUID of the User to update.",
2775               "required": true,
2776               "location": "path"
2777             },
2778             "select": {
2779               "type": "array",
2780               "description": "An array of names of attributes to return in the response.",
2781               "required": false,
2782               "location": "query"
2783             },
2784             "bypass_federation": {
2785               "type": "boolean",
2786               "required": false,
2787               "default": "false",
2788               "description": "If true, do not try to update the user on any other clusters in the federation,\nonly the cluster that received the request.\nYou must be an administrator to use this flag.",
2789               "location": "query"
2790             }
2791           },
2792           "request": {
2793             "required": true,
2794             "properties": {
2795               "user": {
2796                 "$ref": "User"
2797               }
2798             }
2799           },
2800           "response": {
2801             "$ref": "User"
2802           },
2803           "scopes": [
2804             "https://api.arvados.org/auth/arvados"
2805           ]
2806         },
2807         "delete": {
2808           "id": "arvados.users.delete",
2809           "path": "users/{uuid}",
2810           "httpMethod": "DELETE",
2811           "description": "Delete an existing User.",
2812           "parameters": {
2813             "uuid": {
2814               "type": "string",
2815               "description": "The UUID of the User to delete.",
2816               "required": true,
2817               "location": "path"
2818             }
2819           },
2820           "response": {
2821             "$ref": "User"
2822           },
2823           "scopes": [
2824             "https://api.arvados.org/auth/arvados"
2825           ]
2826         },
2827         "current": {
2828           "id": "arvados.users.current",
2829           "path": "users/current",
2830           "httpMethod": "GET",
2831           "description": "Return the user record associated with the API token authorizing this request.",
2832           "parameters": {},
2833           "response": {
2834             "$ref": "User"
2835           },
2836           "scopes": [
2837             "https://api.arvados.org/auth/arvados"
2838           ]
2839         },
2840         "system": {
2841           "id": "arvados.users.system",
2842           "path": "users/system",
2843           "httpMethod": "GET",
2844           "description": "Return this cluster's system (\"root\") user record.",
2845           "parameters": {},
2846           "response": {
2847             "$ref": "User"
2848           },
2849           "scopes": [
2850             "https://api.arvados.org/auth/arvados"
2851           ]
2852         },
2853         "activate": {
2854           "id": "arvados.users.activate",
2855           "path": "users/{uuid}/activate",
2856           "httpMethod": "POST",
2857           "description": "Set the `is_active` flag on a user record.",
2858           "parameters": {
2859             "uuid": {
2860               "type": "string",
2861               "description": "The UUID of the User to update.",
2862               "required": true,
2863               "location": "path"
2864             }
2865           },
2866           "response": {
2867             "$ref": "User"
2868           },
2869           "scopes": [
2870             "https://api.arvados.org/auth/arvados"
2871           ]
2872         },
2873         "setup": {
2874           "id": "arvados.users.setup",
2875           "path": "users/setup",
2876           "httpMethod": "POST",
2877           "description": "Convenience method to \"fully\" set up a user record with a virtual machine login and notification email.",
2878           "parameters": {
2879             "uuid": {
2880               "type": "string",
2881               "required": false,
2882               "description": "UUID of an existing user record to set up.",
2883               "location": "query"
2884             },
2885             "user": {
2886               "type": "object",
2887               "required": false,
2888               "description": "Attributes of a new user record to set up.",
2889               "location": "query"
2890             },
2891             "repo_name": {
2892               "type": "string",
2893               "required": false,
2894               "description": "This parameter is obsolete and ignored.",
2895               "location": "query"
2896             },
2897             "vm_uuid": {
2898               "type": "string",
2899               "required": false,
2900               "description": "If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID.",
2901               "location": "query"
2902             },
2903             "send_notification_email": {
2904               "type": "boolean",
2905               "required": false,
2906               "default": "false",
2907               "description": "If true, send an email to the user notifying them they can now access this Arvados cluster.",
2908               "location": "query"
2909             }
2910           },
2911           "response": {
2912             "$ref": "User"
2913           },
2914           "scopes": [
2915             "https://api.arvados.org/auth/arvados"
2916           ]
2917         },
2918         "unsetup": {
2919           "id": "arvados.users.unsetup",
2920           "path": "users/{uuid}/unsetup",
2921           "httpMethod": "POST",
2922           "description": "Unset a user's active flag and delete associated records.",
2923           "parameters": {
2924             "uuid": {
2925               "type": "string",
2926               "description": "The UUID of the User to update.",
2927               "required": true,
2928               "location": "path"
2929             }
2930           },
2931           "response": {
2932             "$ref": "User"
2933           },
2934           "scopes": [
2935             "https://api.arvados.org/auth/arvados"
2936           ]
2937         },
2938         "merge": {
2939           "id": "arvados.users.merge",
2940           "path": "users/merge",
2941           "httpMethod": "POST",
2942           "description": "Transfer ownership of one user's data to another.",
2943           "parameters": {
2944             "new_owner_uuid": {
2945               "type": "string",
2946               "required": true,
2947               "description": "UUID of the user or group that will take ownership of data owned by the old user.",
2948               "location": "query"
2949             },
2950             "new_user_token": {
2951               "type": "string",
2952               "required": false,
2953               "description": "Valid API token for the user receiving ownership. If you use this option, it takes ownership of data owned by the user making the request.",
2954               "location": "query"
2955             },
2956             "redirect_to_new_user": {
2957               "type": "boolean",
2958               "required": false,
2959               "default": "false",
2960               "description": "If true, authorization attempts for the old user will be redirected to the new user.",
2961               "location": "query"
2962             },
2963             "old_user_uuid": {
2964               "type": "string",
2965               "required": false,
2966               "description": "UUID of the user whose ownership is being transferred to `new_owner_uuid`. You must be an admin to use this option.",
2967               "location": "query"
2968             },
2969             "new_user_uuid": {
2970               "type": "string",
2971               "required": false,
2972               "description": "UUID of the user receiving ownership. You must be an admin to use this option.",
2973               "location": "query"
2974             }
2975           },
2976           "response": {
2977             "$ref": "User"
2978           },
2979           "scopes": [
2980             "https://api.arvados.org/auth/arvados"
2981           ]
2982         }
2983       }
2984     },
2985     "user_agreements": {
2986       "methods": {
2987         "get": {
2988           "id": "arvados.user_agreements.get",
2989           "path": "user_agreements/{uuid}",
2990           "httpMethod": "GET",
2991           "description": "Get a UserAgreement record by UUID.",
2992           "parameters": {
2993             "uuid": {
2994               "type": "string",
2995               "description": "The UUID of the UserAgreement to return.",
2996               "required": true,
2997               "location": "path"
2998             },
2999             "select": {
3000               "type": "array",
3001               "description": "An array of names of attributes to return in the response.",
3002               "required": false,
3003               "location": "query"
3004             }
3005           },
3006           "parameterOrder": [
3007             "uuid"
3008           ],
3009           "response": {
3010             "$ref": "UserAgreement"
3011           },
3012           "scopes": [
3013             "https://api.arvados.org/auth/arvados",
3014             "https://api.arvados.org/auth/arvados.readonly"
3015           ]
3016         },
3017         "list": {
3018           "id": "arvados.user_agreements.list",
3019           "path": "user_agreements",
3020           "httpMethod": "GET",
3021           "description": "Retrieve a UserAgreementList.",
3022           "parameters": {
3023             "filters": {
3024               "type": "array",
3025               "required": false,
3026               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
3027               "location": "query"
3028             },
3029             "where": {
3030               "type": "object",
3031               "required": false,
3032               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
3033               "location": "query"
3034             },
3035             "order": {
3036               "type": "array",
3037               "required": false,
3038               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
3039               "location": "query"
3040             },
3041             "select": {
3042               "type": "array",
3043               "description": "An array of names of attributes to return from each matching object.",
3044               "required": false,
3045               "location": "query"
3046             },
3047             "distinct": {
3048               "type": "boolean",
3049               "required": false,
3050               "default": "false",
3051               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
3052               "location": "query"
3053             },
3054             "limit": {
3055               "type": "integer",
3056               "required": false,
3057               "default": "100",
3058               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
3059               "location": "query"
3060             },
3061             "offset": {
3062               "type": "integer",
3063               "required": false,
3064               "default": "0",
3065               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
3066               "location": "query"
3067             },
3068             "count": {
3069               "type": "string",
3070               "required": false,
3071               "default": "exact",
3072               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
3073               "location": "query"
3074             },
3075             "cluster_id": {
3076               "type": "string",
3077               "description": "Cluster ID of a federated cluster to return objects from",
3078               "location": "query",
3079               "required": false
3080             },
3081             "bypass_federation": {
3082               "type": "boolean",
3083               "required": false,
3084               "default": "false",
3085               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
3086               "location": "query"
3087             }
3088           },
3089           "response": {
3090             "$ref": "UserAgreementList"
3091           },
3092           "scopes": [
3093             "https://api.arvados.org/auth/arvados",
3094             "https://api.arvados.org/auth/arvados.readonly"
3095           ]
3096         },
3097         "create": {
3098           "id": "arvados.user_agreements.create",
3099           "path": "user_agreements",
3100           "httpMethod": "POST",
3101           "description": "Create a new UserAgreement.",
3102           "parameters": {
3103             "select": {
3104               "type": "array",
3105               "description": "An array of names of attributes to return in the response.",
3106               "required": false,
3107               "location": "query"
3108             },
3109             "ensure_unique_name": {
3110               "type": "boolean",
3111               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
3112               "location": "query",
3113               "required": false,
3114               "default": "false"
3115             },
3116             "cluster_id": {
3117               "type": "string",
3118               "description": "Cluster ID of a federated cluster where this object should be created.",
3119               "location": "query",
3120               "required": false
3121             }
3122           },
3123           "request": {
3124             "required": true,
3125             "properties": {
3126               "user_agreement": {
3127                 "$ref": "UserAgreement"
3128               }
3129             }
3130           },
3131           "response": {
3132             "$ref": "UserAgreement"
3133           },
3134           "scopes": [
3135             "https://api.arvados.org/auth/arvados"
3136           ]
3137         },
3138         "update": {
3139           "id": "arvados.user_agreements.update",
3140           "path": "user_agreements/{uuid}",
3141           "httpMethod": "PUT",
3142           "description": "Update attributes of an existing UserAgreement.",
3143           "parameters": {
3144             "uuid": {
3145               "type": "string",
3146               "description": "The UUID of the UserAgreement to update.",
3147               "required": true,
3148               "location": "path"
3149             },
3150             "select": {
3151               "type": "array",
3152               "description": "An array of names of attributes to return in the response.",
3153               "required": false,
3154               "location": "query"
3155             }
3156           },
3157           "request": {
3158             "required": true,
3159             "properties": {
3160               "user_agreement": {
3161                 "$ref": "UserAgreement"
3162               }
3163             }
3164           },
3165           "response": {
3166             "$ref": "UserAgreement"
3167           },
3168           "scopes": [
3169             "https://api.arvados.org/auth/arvados"
3170           ]
3171         },
3172         "delete": {
3173           "id": "arvados.user_agreements.delete",
3174           "path": "user_agreements/{uuid}",
3175           "httpMethod": "DELETE",
3176           "description": "Delete an existing UserAgreement.",
3177           "parameters": {
3178             "uuid": {
3179               "type": "string",
3180               "description": "The UUID of the UserAgreement to delete.",
3181               "required": true,
3182               "location": "path"
3183             }
3184           },
3185           "response": {
3186             "$ref": "UserAgreement"
3187           },
3188           "scopes": [
3189             "https://api.arvados.org/auth/arvados"
3190           ]
3191         },
3192         "signatures": {
3193           "id": "arvados.user_agreements.signatures",
3194           "path": "user_agreements/signatures",
3195           "httpMethod": "GET",
3196           "description": "List all user agreement signature links from a user.",
3197           "parameters": {},
3198           "response": {
3199             "$ref": "UserAgreement"
3200           },
3201           "scopes": [
3202             "https://api.arvados.org/auth/arvados"
3203           ]
3204         },
3205         "sign": {
3206           "id": "arvados.user_agreements.sign",
3207           "path": "user_agreements/sign",
3208           "httpMethod": "POST",
3209           "description": "Create a signature link from the current user for a given user agreement.",
3210           "parameters": {},
3211           "response": {
3212             "$ref": "UserAgreement"
3213           },
3214           "scopes": [
3215             "https://api.arvados.org/auth/arvados"
3216           ]
3217         }
3218       }
3219     },
3220     "virtual_machines": {
3221       "methods": {
3222         "get": {
3223           "id": "arvados.virtual_machines.get",
3224           "path": "virtual_machines/{uuid}",
3225           "httpMethod": "GET",
3226           "description": "Get a VirtualMachine record by UUID.",
3227           "parameters": {
3228             "uuid": {
3229               "type": "string",
3230               "description": "The UUID of the VirtualMachine to return.",
3231               "required": true,
3232               "location": "path"
3233             },
3234             "select": {
3235               "type": "array",
3236               "description": "An array of names of attributes to return in the response.",
3237               "required": false,
3238               "location": "query"
3239             }
3240           },
3241           "parameterOrder": [
3242             "uuid"
3243           ],
3244           "response": {
3245             "$ref": "VirtualMachine"
3246           },
3247           "scopes": [
3248             "https://api.arvados.org/auth/arvados",
3249             "https://api.arvados.org/auth/arvados.readonly"
3250           ]
3251         },
3252         "list": {
3253           "id": "arvados.virtual_machines.list",
3254           "path": "virtual_machines",
3255           "httpMethod": "GET",
3256           "description": "Retrieve a VirtualMachineList.",
3257           "parameters": {
3258             "filters": {
3259               "type": "array",
3260               "required": false,
3261               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
3262               "location": "query"
3263             },
3264             "where": {
3265               "type": "object",
3266               "required": false,
3267               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
3268               "location": "query"
3269             },
3270             "order": {
3271               "type": "array",
3272               "required": false,
3273               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
3274               "location": "query"
3275             },
3276             "select": {
3277               "type": "array",
3278               "description": "An array of names of attributes to return from each matching object.",
3279               "required": false,
3280               "location": "query"
3281             },
3282             "distinct": {
3283               "type": "boolean",
3284               "required": false,
3285               "default": "false",
3286               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
3287               "location": "query"
3288             },
3289             "limit": {
3290               "type": "integer",
3291               "required": false,
3292               "default": "100",
3293               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
3294               "location": "query"
3295             },
3296             "offset": {
3297               "type": "integer",
3298               "required": false,
3299               "default": "0",
3300               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
3301               "location": "query"
3302             },
3303             "count": {
3304               "type": "string",
3305               "required": false,
3306               "default": "exact",
3307               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
3308               "location": "query"
3309             },
3310             "cluster_id": {
3311               "type": "string",
3312               "description": "Cluster ID of a federated cluster to return objects from",
3313               "location": "query",
3314               "required": false
3315             },
3316             "bypass_federation": {
3317               "type": "boolean",
3318               "required": false,
3319               "default": "false",
3320               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
3321               "location": "query"
3322             }
3323           },
3324           "response": {
3325             "$ref": "VirtualMachineList"
3326           },
3327           "scopes": [
3328             "https://api.arvados.org/auth/arvados",
3329             "https://api.arvados.org/auth/arvados.readonly"
3330           ]
3331         },
3332         "create": {
3333           "id": "arvados.virtual_machines.create",
3334           "path": "virtual_machines",
3335           "httpMethod": "POST",
3336           "description": "Create a new VirtualMachine.",
3337           "parameters": {
3338             "select": {
3339               "type": "array",
3340               "description": "An array of names of attributes to return in the response.",
3341               "required": false,
3342               "location": "query"
3343             },
3344             "ensure_unique_name": {
3345               "type": "boolean",
3346               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
3347               "location": "query",
3348               "required": false,
3349               "default": "false"
3350             },
3351             "cluster_id": {
3352               "type": "string",
3353               "description": "Cluster ID of a federated cluster where this object should be created.",
3354               "location": "query",
3355               "required": false
3356             }
3357           },
3358           "request": {
3359             "required": true,
3360             "properties": {
3361               "virtual_machine": {
3362                 "$ref": "VirtualMachine"
3363               }
3364             }
3365           },
3366           "response": {
3367             "$ref": "VirtualMachine"
3368           },
3369           "scopes": [
3370             "https://api.arvados.org/auth/arvados"
3371           ]
3372         },
3373         "update": {
3374           "id": "arvados.virtual_machines.update",
3375           "path": "virtual_machines/{uuid}",
3376           "httpMethod": "PUT",
3377           "description": "Update attributes of an existing VirtualMachine.",
3378           "parameters": {
3379             "uuid": {
3380               "type": "string",
3381               "description": "The UUID of the VirtualMachine to update.",
3382               "required": true,
3383               "location": "path"
3384             },
3385             "select": {
3386               "type": "array",
3387               "description": "An array of names of attributes to return in the response.",
3388               "required": false,
3389               "location": "query"
3390             }
3391           },
3392           "request": {
3393             "required": true,
3394             "properties": {
3395               "virtual_machine": {
3396                 "$ref": "VirtualMachine"
3397               }
3398             }
3399           },
3400           "response": {
3401             "$ref": "VirtualMachine"
3402           },
3403           "scopes": [
3404             "https://api.arvados.org/auth/arvados"
3405           ]
3406         },
3407         "delete": {
3408           "id": "arvados.virtual_machines.delete",
3409           "path": "virtual_machines/{uuid}",
3410           "httpMethod": "DELETE",
3411           "description": "Delete an existing VirtualMachine.",
3412           "parameters": {
3413             "uuid": {
3414               "type": "string",
3415               "description": "The UUID of the VirtualMachine to delete.",
3416               "required": true,
3417               "location": "path"
3418             }
3419           },
3420           "response": {
3421             "$ref": "VirtualMachine"
3422           },
3423           "scopes": [
3424             "https://api.arvados.org/auth/arvados"
3425           ]
3426         },
3427         "logins": {
3428           "id": "arvados.virtual_machines.logins",
3429           "path": "virtual_machines/{uuid}/logins",
3430           "httpMethod": "GET",
3431           "description": "List login permission links for a given virtual machine.",
3432           "parameters": {
3433             "uuid": {
3434               "type": "string",
3435               "description": "The UUID of the VirtualMachine to query.",
3436               "required": true,
3437               "location": "path"
3438             }
3439           },
3440           "response": {
3441             "$ref": "VirtualMachine"
3442           },
3443           "scopes": [
3444             "https://api.arvados.org/auth/arvados"
3445           ]
3446         },
3447         "get_all_logins": {
3448           "id": "arvados.virtual_machines.get_all_logins",
3449           "path": "virtual_machines/get_all_logins",
3450           "httpMethod": "GET",
3451           "description": "List login permission links for all virtual machines.",
3452           "parameters": {},
3453           "response": {
3454             "$ref": "VirtualMachine"
3455           },
3456           "scopes": [
3457             "https://api.arvados.org/auth/arvados"
3458           ]
3459         }
3460       }
3461     },
3462     "workflows": {
3463       "methods": {
3464         "get": {
3465           "id": "arvados.workflows.get",
3466           "path": "workflows/{uuid}",
3467           "httpMethod": "GET",
3468           "description": "Get a Workflow record by UUID.",
3469           "parameters": {
3470             "uuid": {
3471               "type": "string",
3472               "description": "The UUID of the Workflow to return.",
3473               "required": true,
3474               "location": "path"
3475             },
3476             "select": {
3477               "type": "array",
3478               "description": "An array of names of attributes to return in the response.",
3479               "required": false,
3480               "location": "query"
3481             }
3482           },
3483           "parameterOrder": [
3484             "uuid"
3485           ],
3486           "response": {
3487             "$ref": "Workflow"
3488           },
3489           "scopes": [
3490             "https://api.arvados.org/auth/arvados",
3491             "https://api.arvados.org/auth/arvados.readonly"
3492           ]
3493         },
3494         "list": {
3495           "id": "arvados.workflows.list",
3496           "path": "workflows",
3497           "httpMethod": "GET",
3498           "description": "Retrieve a WorkflowList.",
3499           "parameters": {
3500             "filters": {
3501               "type": "array",
3502               "required": false,
3503               "description": "Filters to limit which objects are returned by their attributes.\nRefer to the [filters reference][] for more information about how to write filters.\n\n[filters reference]: https://doc.arvados.org/api/methods.html#filters\n",
3504               "location": "query"
3505             },
3506             "where": {
3507               "type": "object",
3508               "required": false,
3509               "description": "An object to limit which objects are returned by their attributes.\nThe keys of this object are attribute names.\nEach value is either a single matching value or an array of matching values for that attribute.\nThe `filters` parameter is more flexible and preferred.\n",
3510               "location": "query"
3511             },
3512             "order": {
3513               "type": "array",
3514               "required": false,
3515               "description": "An array of strings to set the order in which matching objects are returned.\nEach string has the format `<ATTRIBUTE> <DIRECTION>`.\n`DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending.\n",
3516               "location": "query"
3517             },
3518             "select": {
3519               "type": "array",
3520               "description": "An array of names of attributes to return from each matching object.",
3521               "required": false,
3522               "location": "query"
3523             },
3524             "distinct": {
3525               "type": "boolean",
3526               "required": false,
3527               "default": "false",
3528               "description": "If this is true, and multiple objects have the same values\nfor the attributes that you specify in the `select` parameter, then each unique\nset of values will only be returned once in the result set.\n",
3529               "location": "query"
3530             },
3531             "limit": {
3532               "type": "integer",
3533               "required": false,
3534               "default": "100",
3535               "description": "The maximum number of objects to return in the result.\nNote that the API may return fewer results than this if your request hits other\nlimits set by the administrator.\n",
3536               "location": "query"
3537             },
3538             "offset": {
3539               "type": "integer",
3540               "required": false,
3541               "default": "0",
3542               "description": "Return matching objects starting from this index.\nNote that result indexes may change if objects are modified in between a series\nof list calls.\n",
3543               "location": "query"
3544             },
3545             "count": {
3546               "type": "string",
3547               "required": false,
3548               "default": "exact",
3549               "description": "A string to determine result counting behavior. Supported values are:\n\n  * `\"exact\"`: The response will include an `items_available` field that\n    counts the number of objects that matched this search criteria,\n    including ones not included in `items`.\n\n  * `\"none\"`: The response will not include an `items_avaliable`\n    field. This improves performance by returning a result as soon as enough\n    `items` have been loaded for this result.\n\n",
3550               "location": "query"
3551             },
3552             "cluster_id": {
3553               "type": "string",
3554               "description": "Cluster ID of a federated cluster to return objects from",
3555               "location": "query",
3556               "required": false
3557             },
3558             "bypass_federation": {
3559               "type": "boolean",
3560               "required": false,
3561               "default": "false",
3562               "description": "If true, do not return results from other clusters in the\nfederation, only the cluster that received the request.\nYou must be an administrator to use this flag.\n",
3563               "location": "query"
3564             }
3565           },
3566           "response": {
3567             "$ref": "WorkflowList"
3568           },
3569           "scopes": [
3570             "https://api.arvados.org/auth/arvados",
3571             "https://api.arvados.org/auth/arvados.readonly"
3572           ]
3573         },
3574         "create": {
3575           "id": "arvados.workflows.create",
3576           "path": "workflows",
3577           "httpMethod": "POST",
3578           "description": "Create a new Workflow.",
3579           "parameters": {
3580             "select": {
3581               "type": "array",
3582               "description": "An array of names of attributes to return in the response.",
3583               "required": false,
3584               "location": "query"
3585             },
3586             "ensure_unique_name": {
3587               "type": "boolean",
3588               "description": "If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error.",
3589               "location": "query",
3590               "required": false,
3591               "default": "false"
3592             },
3593             "cluster_id": {
3594               "type": "string",
3595               "description": "Cluster ID of a federated cluster where this object should be created.",
3596               "location": "query",
3597               "required": false
3598             }
3599           },
3600           "request": {
3601             "required": true,
3602             "properties": {
3603               "workflow": {
3604                 "$ref": "Workflow"
3605               }
3606             }
3607           },
3608           "response": {
3609             "$ref": "Workflow"
3610           },
3611           "scopes": [
3612             "https://api.arvados.org/auth/arvados"
3613           ]
3614         },
3615         "update": {
3616           "id": "arvados.workflows.update",
3617           "path": "workflows/{uuid}",
3618           "httpMethod": "PUT",
3619           "description": "Update attributes of an existing Workflow.",
3620           "parameters": {
3621             "uuid": {
3622               "type": "string",
3623               "description": "The UUID of the Workflow to update.",
3624               "required": true,
3625               "location": "path"
3626             },
3627             "select": {
3628               "type": "array",
3629               "description": "An array of names of attributes to return in the response.",
3630               "required": false,
3631               "location": "query"
3632             }
3633           },
3634           "request": {
3635             "required": true,
3636             "properties": {
3637               "workflow": {
3638                 "$ref": "Workflow"
3639               }
3640             }
3641           },
3642           "response": {
3643             "$ref": "Workflow"
3644           },
3645           "scopes": [
3646             "https://api.arvados.org/auth/arvados"
3647           ]
3648         },
3649         "delete": {
3650           "id": "arvados.workflows.delete",
3651           "path": "workflows/{uuid}",
3652           "httpMethod": "DELETE",
3653           "description": "Delete an existing Workflow.",
3654           "parameters": {
3655             "uuid": {
3656               "type": "string",
3657               "description": "The UUID of the Workflow to delete.",
3658               "required": true,
3659               "location": "path"
3660             }
3661           },
3662           "response": {
3663             "$ref": "Workflow"
3664           },
3665           "scopes": [
3666             "https://api.arvados.org/auth/arvados"
3667           ]
3668         }
3669       }
3670     },
3671     "configs": {
3672       "methods": {
3673         "get": {
3674           "id": "arvados.configs.get",
3675           "path": "config",
3676           "httpMethod": "GET",
3677           "description": "Get this cluster's public configuration settings.",
3678           "parameters": {},
3679           "parameterOrder": [],
3680           "response": {},
3681           "scopes": [
3682             "https://api.arvados.org/auth/arvados",
3683             "https://api.arvados.org/auth/arvados.readonly"
3684           ]
3685         }
3686       }
3687     },
3688     "vocabularies": {
3689       "methods": {
3690         "get": {
3691           "id": "arvados.vocabularies.get",
3692           "path": "vocabulary",
3693           "httpMethod": "GET",
3694           "description": "Get this cluster's configured vocabulary definition.\n\nRefer to [metadata vocabulary documentation][] for details.\n\n[metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html\n\n",
3695           "parameters": {},
3696           "parameterOrder": [],
3697           "response": {},
3698           "scopes": [
3699             "https://api.arvados.org/auth/arvados",
3700             "https://api.arvados.org/auth/arvados.readonly"
3701           ]
3702         }
3703       }
3704     },
3705     "sys": {
3706       "methods": {
3707         "get": {
3708           "id": "arvados.sys.trash_sweep",
3709           "path": "sys/trash_sweep",
3710           "httpMethod": "POST",
3711           "description": "Run scheduled data trash and sweep operations across this cluster's Keep services.",
3712           "parameters": {},
3713           "parameterOrder": [],
3714           "response": {},
3715           "scopes": [
3716             "https://api.arvados.org/auth/arvados",
3717             "https://api.arvados.org/auth/arvados.readonly"
3718           ]
3719         }
3720       }
3721     }
3722   },
3723   "revision": "20240627",
3724   "schemas": {
3725     "ApiClientAuthorizationList": {
3726       "id": "ApiClientAuthorizationList",
3727       "description": "A list of ApiClientAuthorization objects.",
3728       "type": "object",
3729       "properties": {
3730         "kind": {
3731           "type": "string",
3732           "description": "Object type. Always arvados#apiClientAuthorizationList.",
3733           "default": "arvados#apiClientAuthorizationList"
3734         },
3735         "etag": {
3736           "type": "string",
3737           "description": "List cache version."
3738         },
3739         "items": {
3740           "type": "array",
3741           "description": "An array of matching ApiClientAuthorization objects.",
3742           "items": {
3743             "$ref": "ApiClientAuthorization"
3744           }
3745         }
3746       }
3747     },
3748     "ApiClientAuthorization": {
3749       "id": "ApiClientAuthorization",
3750       "description": "Arvados API client authorization token\n\nThis resource represents an API token a user may use to authenticate an\nArvados API request.",
3751       "type": "object",
3752       "uuidPrefix": "gj3su",
3753       "properties": {
3754         "etag": {
3755           "type": "string",
3756           "description": "Object cache version."
3757         },
3758         "api_token": {
3759           "description": "The secret token that can be used to authorize Arvados API requests.",
3760           "type": "string"
3761         },
3762         "created_by_ip_address": {
3763           "description": "The IP address of the client that created this token.",
3764           "type": "string"
3765         },
3766         "last_used_by_ip_address": {
3767           "description": "The IP address of the client that last used this token.",
3768           "type": "string"
3769         },
3770         "last_used_at": {
3771           "description": "The last time this token was used to authorize a request. The string encodes a UTC date and time in ISO 8601 format.",
3772           "type": "datetime"
3773         },
3774         "expires_at": {
3775           "description": "The time after which this token is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format.",
3776           "type": "datetime"
3777         },
3778         "created_at": {
3779           "description": "The time this API client authorization was created. The string encodes a UTC date and time in ISO 8601 format.",
3780           "type": "datetime"
3781         },
3782         "scopes": {
3783           "description": "An array of strings identifying HTTP methods and API paths this token is\nauthorized to use. Refer to the [scopes reference][] for details.\n\n[scopes reference]: https://doc.arvados.org/api/tokens.html#scopes\n\n",
3784           "type": "Array"
3785         },
3786         "uuid": {
3787           "type": "string",
3788           "description": "This API client authorization's Arvados UUID, like `zzzzz-gj3su-12345abcde67890`."
3789         }
3790       }
3791     },
3792     "AuthorizedKeyList": {
3793       "id": "AuthorizedKeyList",
3794       "description": "A list of AuthorizedKey objects.",
3795       "type": "object",
3796       "properties": {
3797         "kind": {
3798           "type": "string",
3799           "description": "Object type. Always arvados#authorizedKeyList.",
3800           "default": "arvados#authorizedKeyList"
3801         },
3802         "etag": {
3803           "type": "string",
3804           "description": "List cache version."
3805         },
3806         "items": {
3807           "type": "array",
3808           "description": "An array of matching AuthorizedKey objects.",
3809           "items": {
3810             "$ref": "AuthorizedKey"
3811           }
3812         }
3813       }
3814     },
3815     "AuthorizedKey": {
3816       "id": "AuthorizedKey",
3817       "description": "Arvados authorized public key\n\nThis resource represents a public key a user may use to authenticate themselves\nto services on the cluster. Its primary use today is to store SSH keys for\nvirtual machines (\"shell nodes\"). It may be extended to store other keys in\nthe future.",
3818       "type": "object",
3819       "uuidPrefix": "fngyi",
3820       "properties": {
3821         "etag": {
3822           "type": "string",
3823           "description": "Object cache version."
3824         },
3825         "uuid": {
3826           "type": "string",
3827           "description": "This authorized key's Arvados UUID, like `zzzzz-fngyi-12345abcde67890`."
3828         },
3829         "owner_uuid": {
3830           "description": "The UUID of the user or group that owns this authorized key.",
3831           "type": "string"
3832         },
3833         "modified_by_user_uuid": {
3834           "description": "The UUID of the user that last updated this authorized key.",
3835           "type": "string"
3836         },
3837         "modified_at": {
3838           "description": "The time this authorized key was last updated. The string encodes a UTC date and time in ISO 8601 format.",
3839           "type": "datetime"
3840         },
3841         "name": {
3842           "description": "The name of this authorized key assigned by a user.",
3843           "type": "string"
3844         },
3845         "key_type": {
3846           "description": "A string identifying what type of service uses this key. Supported values are:\n\n  * `\"SSH\"`\n\n",
3847           "type": "string"
3848         },
3849         "authorized_user_uuid": {
3850           "description": "The UUID of the Arvados user that is authorized by this key.",
3851           "type": "string"
3852         },
3853         "public_key": {
3854           "description": "The full public key, in the format referenced by `key_type`.",
3855           "type": "text"
3856         },
3857         "expires_at": {
3858           "description": "The time after which this key is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format.",
3859           "type": "datetime"
3860         },
3861         "created_at": {
3862           "description": "The time this authorized key was created. The string encodes a UTC date and time in ISO 8601 format.",
3863           "type": "datetime"
3864         }
3865       }
3866     },
3867     "CollectionList": {
3868       "id": "CollectionList",
3869       "description": "A list of Collection objects.",
3870       "type": "object",
3871       "properties": {
3872         "kind": {
3873           "type": "string",
3874           "description": "Object type. Always arvados#collectionList.",
3875           "default": "arvados#collectionList"
3876         },
3877         "etag": {
3878           "type": "string",
3879           "description": "List cache version."
3880         },
3881         "items": {
3882           "type": "array",
3883           "description": "An array of matching Collection objects.",
3884           "items": {
3885             "$ref": "Collection"
3886           }
3887         }
3888       }
3889     },
3890     "Collection": {
3891       "id": "Collection",
3892       "description": "Arvados data collection\n\nA collection describes how a set of files is stored in data blocks in Keep,\nalong with associated metadata.",
3893       "type": "object",
3894       "uuidPrefix": "4zz18",
3895       "properties": {
3896         "etag": {
3897           "type": "string",
3898           "description": "Object cache version."
3899         },
3900         "owner_uuid": {
3901           "description": "The UUID of the user or group that owns this collection.",
3902           "type": "string"
3903         },
3904         "created_at": {
3905           "description": "The time this collection was created. The string encodes a UTC date and time in ISO 8601 format.",
3906           "type": "datetime"
3907         },
3908         "modified_by_user_uuid": {
3909           "description": "The UUID of the user that last updated this collection.",
3910           "type": "string"
3911         },
3912         "modified_at": {
3913           "description": "The time this collection was last updated. The string encodes a UTC date and time in ISO 8601 format.",
3914           "type": "datetime"
3915         },
3916         "portable_data_hash": {
3917           "description": "The portable data hash of this collection. This string provides a unique\nand stable reference to these contents.",
3918           "type": "string"
3919         },
3920         "replication_desired": {
3921           "description": "The number of copies that should be made for data in this collection.",
3922           "type": "integer"
3923         },
3924         "replication_confirmed_at": {
3925           "description": "The last time the cluster confirmed that it met `replication_confirmed`\nfor this collection. The string encodes a UTC date and time in ISO 8601 format.",
3926           "type": "datetime"
3927         },
3928         "replication_confirmed": {
3929           "description": "The number of copies of data in this collection that the cluster has confirmed\nexist in storage.",
3930           "type": "integer"
3931         },
3932         "uuid": {
3933           "type": "string",
3934           "description": "This collection's Arvados UUID, like `zzzzz-4zz18-12345abcde67890`."
3935         },
3936         "manifest_text": {
3937           "description": "The manifest text that describes how files are constructed from data blocks\nin this collection. Refer to the [manifest format][] reference for details.\n\n[manifest format]: https://doc.arvados.org/architecture/manifest-format.html\n\n",
3938           "type": "text"
3939         },
3940         "name": {
3941           "description": "The name of this collection assigned by a user.",
3942           "type": "string"
3943         },
3944         "description": {
3945           "description": "A longer description of this collection assigned by a user.",
3946           "type": "string"
3947         },
3948         "properties": {
3949           "description": "A hash of arbitrary metadata for this collection.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
3950           "type": "Hash"
3951         },
3952         "delete_at": {
3953           "description": "The time this collection will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format.",
3954           "type": "datetime"
3955         },
3956         "trash_at": {
3957           "description": "The time this collection will be trashed. The string encodes a UTC date and time in ISO 8601 format.",
3958           "type": "datetime"
3959         },
3960         "is_trashed": {
3961           "description": "A boolean flag to indicate whether or not this collection is trashed.",
3962           "type": "boolean"
3963         },
3964         "storage_classes_desired": {
3965           "description": "An array of strings identifying the storage class(es) that should be used\nfor data in this collection. Storage classes are configured by the cluster administrator.",
3966           "type": "Array"
3967         },
3968         "storage_classes_confirmed": {
3969           "description": "An array of strings identifying the storage class(es) the cluster has\nconfirmed have a copy of this collection's data.",
3970           "type": "Array"
3971         },
3972         "storage_classes_confirmed_at": {
3973           "description": "The last time the cluster confirmed that data was stored on the storage\nclass(es) in `storage_classes_confirmed`. The string encodes a UTC date and time in ISO 8601 format.",
3974           "type": "datetime"
3975         },
3976         "current_version_uuid": {
3977           "description": "The UUID of the current version of this collection.",
3978           "type": "string"
3979         },
3980         "version": {
3981           "description": "An integer that counts which version of a collection this record\nrepresents. Refer to [collection versioning][] for details. This attribute is\nread-only.\n\n[collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html\n\n",
3982           "type": "integer"
3983         },
3984         "preserve_version": {
3985           "description": "A boolean flag to indicate whether this specific version of this collection\nshould be persisted in cluster storage.",
3986           "type": "boolean"
3987         },
3988         "file_count": {
3989           "description": "The number of files represented in this collection's `manifest_text`.\nThis attribute is read-only.",
3990           "type": "integer"
3991         },
3992         "file_size_total": {
3993           "description": "The total size in bytes of files represented in this collection's `manifest_text`.\nThis attribute is read-only.",
3994           "type": "integer"
3995         }
3996       }
3997     },
3998     "ComputedPermissionList": {
3999       "id": "ComputedPermissionList",
4000       "description": "A list of ComputedPermission objects.",
4001       "type": "object",
4002       "properties": {
4003         "kind": {
4004           "type": "string",
4005           "description": "Object type. Always arvados#computedPermissionList.",
4006           "default": "arvados#computedPermissionList"
4007         },
4008         "etag": {
4009           "type": "string",
4010           "description": "List cache version."
4011         },
4012         "items": {
4013           "type": "array",
4014           "description": "An array of matching ComputedPermission objects.",
4015           "items": {
4016             "$ref": "ComputedPermission"
4017           }
4018         }
4019       }
4020     },
4021     "ComputedPermission": {
4022       "id": "ComputedPermission",
4023       "description": "Arvados computed permission\n\nComputed permissions do not correspond directly to any Arvados resource, but\nprovide a simple way to query the entire graph of permissions granted to\nusers and groups.",
4024       "type": "object",
4025       "properties": {
4026         "user_uuid": {
4027           "description": "The UUID of the Arvados user who has this permission.",
4028           "type": "string"
4029         },
4030         "target_uuid": {
4031           "description": "The UUID of the Arvados object the user has access to.",
4032           "type": "string"
4033         },
4034         "perm_level": {
4035           "description": "A string representing the user's level of access to the target object.\nPossible values are:\n\n  * `\"can_read\"`\n  * `\"can_write\"`\n  * `\"can_manage\"`\n\n",
4036           "type": "string"
4037         }
4038       }
4039     },
4040     "ContainerList": {
4041       "id": "ContainerList",
4042       "description": "A list of Container objects.",
4043       "type": "object",
4044       "properties": {
4045         "kind": {
4046           "type": "string",
4047           "description": "Object type. Always arvados#containerList.",
4048           "default": "arvados#containerList"
4049         },
4050         "etag": {
4051           "type": "string",
4052           "description": "List cache version."
4053         },
4054         "items": {
4055           "type": "array",
4056           "description": "An array of matching Container objects.",
4057           "items": {
4058             "$ref": "Container"
4059           }
4060         }
4061       }
4062     },
4063     "Container": {
4064       "id": "Container",
4065       "description": "Arvados container record\n\nA container represents compute work that has been or should be dispatched,\nalong with its results. A container can satisfy one or more container requests.",
4066       "type": "object",
4067       "uuidPrefix": "dz642",
4068       "properties": {
4069         "etag": {
4070           "type": "string",
4071           "description": "Object cache version."
4072         },
4073         "uuid": {
4074           "type": "string",
4075           "description": "This container's Arvados UUID, like `zzzzz-dz642-12345abcde67890`."
4076         },
4077         "owner_uuid": {
4078           "description": "The UUID of the user or group that owns this container.",
4079           "type": "string"
4080         },
4081         "created_at": {
4082           "description": "The time this container was created. The string encodes a UTC date and time in ISO 8601 format.",
4083           "type": "datetime"
4084         },
4085         "modified_at": {
4086           "description": "The time this container was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4087           "type": "datetime"
4088         },
4089         "modified_by_user_uuid": {
4090           "description": "The UUID of the user that last updated this container.",
4091           "type": "string"
4092         },
4093         "state": {
4094           "description": "A string representing the container's current execution status. Possible\nvalues are:\n\n  * `\"Queued\"` --- This container has not been dispatched yet.\n  * `\"Locked\"` --- A dispatcher has claimed this container in preparation to run it.\n  * `\"Running\"` --- A dispatcher is running this container.\n  * `\"Cancelled\"` --- Container execution has been cancelled by user request.\n  * `\"Complete\"` --- A dispatcher ran this container to completion and recorded the results.\n\n",
4095           "type": "string"
4096         },
4097         "started_at": {
4098           "description": " The string encodes a UTC date and time in ISO 8601 format.",
4099           "type": "datetime"
4100         },
4101         "finished_at": {
4102           "description": " The string encodes a UTC date and time in ISO 8601 format.",
4103           "type": "datetime"
4104         },
4105         "log": {
4106           "description": "The portable data hash of the Arvados collection that contains this\ncontainer's logs.",
4107           "type": "string"
4108         },
4109         "environment": {
4110           "description": "A hash of string keys and values that defines the environment variables\nfor the dispatcher to set when it executes this container.",
4111           "type": "Hash"
4112         },
4113         "cwd": {
4114           "description": "A string that the defines the working directory that the dispatcher should\nuse when it executes the command inside this container.",
4115           "type": "string"
4116         },
4117         "command": {
4118           "description": "An array of strings that defines the command that the dispatcher should\nexecute inside this container.",
4119           "type": "Array"
4120         },
4121         "output_path": {
4122           "description": "A string that defines the file or directory path where the command\nwrites output that should be saved from this container.",
4123           "type": "string"
4124         },
4125         "mounts": {
4126           "description": "A hash where each key names a directory inside this container, and its\nvalue is an object that defines the mount source for that directory. Refer\nto the [mount types reference][] for details.\n\n[mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types\n\n",
4127           "type": "Hash"
4128         },
4129         "runtime_constraints": {
4130           "description": "A hash that identifies compute resources this container requires to run\nsuccessfully. See the [runtime constraints reference][] for details.\n\n[runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints\n\n",
4131           "type": "Hash"
4132         },
4133         "output": {
4134           "description": "The portable data hash of the Arvados collection that contains this\ncontainer's output file(s).",
4135           "type": "string"
4136         },
4137         "container_image": {
4138           "description": "The portable data hash of the Arvados collection that contains the image\nto use for this container.",
4139           "type": "string"
4140         },
4141         "progress": {
4142           "description": "A float between 0.0 and 1.0 (inclusive) that represents the container's\nexecution progress. This attribute is not implemented yet.",
4143           "type": "float"
4144         },
4145         "priority": {
4146           "description": "An integer between 0 and 1000 (inclusive) that represents this container's\nscheduling priority. 0 represents a request to be cancelled. Higher\nvalues represent higher priority. Refer to the [priority reference][] for details.\n\n[priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority\n\n",
4147           "type": "integer"
4148         },
4149         "exit_code": {
4150           "description": "An integer that records the Unix exit code of the `command` from a\nfinished container.",
4151           "type": "integer"
4152         },
4153         "auth_uuid": {
4154           "description": "The UUID of the Arvados API client authorization token that a dispatcher\nshould use to set up this container. This token is automatically created by\nArvados and this attribute automatically assigned unless a container is\ncreated with `runtime_token`.",
4155           "type": "string"
4156         },
4157         "locked_by_uuid": {
4158           "description": "The UUID of the Arvados API client authorization token that successfully\nlocked this container in preparation to execute it.",
4159           "type": "string"
4160         },
4161         "scheduling_parameters": {
4162           "description": "A hash of scheduling parameters that should be passed to the underlying\ndispatcher when this container is run.\nSee the [scheduling parameters reference][] for details.\n\n[scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters\n\n",
4163           "type": "Hash"
4164         },
4165         "runtime_status": {
4166           "description": "A hash with status updates from a running container.\nRefer to the [runtime status reference][] for details.\n\n[runtime status reference]: https://doc.arvados.org/api/methods/containers.html#runtime_status\n\n",
4167           "type": "Hash"
4168         },
4169         "runtime_user_uuid": {
4170           "description": "The UUID of the Arvados user associated with the API client authorization\ntoken used to run this container.",
4171           "type": "text"
4172         },
4173         "runtime_auth_scopes": {
4174           "description": "The `scopes` from the API client authorization token used to run this container.",
4175           "type": "Array"
4176         },
4177         "lock_count": {
4178           "description": "The number of times this container has been locked by a dispatcher. This\nmay be greater than 1 if a dispatcher locks a container but then execution is\ninterrupted for any reason.",
4179           "type": "integer"
4180         },
4181         "gateway_address": {
4182           "description": "A string with the address of the Arvados gateway server, in `HOST:PORT`\nformat. This is for internal use only.",
4183           "type": "string"
4184         },
4185         "interactive_session_started": {
4186           "description": "This flag is set true if any user starts an interactive shell inside the\nrunning container.",
4187           "type": "boolean"
4188         },
4189         "output_storage_classes": {
4190           "description": "An array of strings identifying the storage class(es) that should be set\non the output collection of this container. Storage classes are configured by\nthe cluster administrator.",
4191           "type": "Array"
4192         },
4193         "output_properties": {
4194           "description": "A hash of arbitrary metadata to set on the output collection of this container.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4195           "type": "Hash"
4196         },
4197         "cost": {
4198           "description": "A float with the estimated cost of the cloud instance used to run this\ncontainer. The value is `0` if cost estimation is not available on this cluster.",
4199           "type": "float"
4200         },
4201         "subrequests_cost": {
4202           "description": "A float with the estimated cost of all cloud instances used to run this\ncontainer and all its subrequests. The value is `0` if cost estimation is not\navailable on this cluster.",
4203           "type": "float"
4204         },
4205         "output_glob": {
4206           "description": "An array of strings of shell-style glob patterns that define which file(s)\nand subdirectory(ies) under the `output_path` directory should be recorded in\nthe container's final output. Refer to the [glob patterns reference][] for details.\n\n[glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns\n\n",
4207           "type": "Array"
4208         }
4209       }
4210     },
4211     "ContainerRequestList": {
4212       "id": "ContainerRequestList",
4213       "description": "A list of ContainerRequest objects.",
4214       "type": "object",
4215       "properties": {
4216         "kind": {
4217           "type": "string",
4218           "description": "Object type. Always arvados#containerRequestList.",
4219           "default": "arvados#containerRequestList"
4220         },
4221         "etag": {
4222           "type": "string",
4223           "description": "List cache version."
4224         },
4225         "items": {
4226           "type": "array",
4227           "description": "An array of matching ContainerRequest objects.",
4228           "items": {
4229             "$ref": "ContainerRequest"
4230           }
4231         }
4232       }
4233     },
4234     "ContainerRequest": {
4235       "id": "ContainerRequest",
4236       "description": "Arvados container request\n\nA container request represents a user's request that Arvados do some compute\nwork, along with full details about what work should be done. Arvados will\nattempt to fulfill the request by mapping it to a matching container record,\nrunning the work on demand if necessary.",
4237       "type": "object",
4238       "uuidPrefix": "xvhdp",
4239       "properties": {
4240         "etag": {
4241           "type": "string",
4242           "description": "Object cache version."
4243         },
4244         "uuid": {
4245           "type": "string",
4246           "description": "This container request's Arvados UUID, like `zzzzz-xvhdp-12345abcde67890`."
4247         },
4248         "owner_uuid": {
4249           "description": "The UUID of the user or group that owns this container request.",
4250           "type": "string"
4251         },
4252         "created_at": {
4253           "description": "The time this container request was created. The string encodes a UTC date and time in ISO 8601 format.",
4254           "type": "datetime"
4255         },
4256         "modified_at": {
4257           "description": "The time this container request was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4258           "type": "datetime"
4259         },
4260         "modified_by_user_uuid": {
4261           "description": "The UUID of the user that last updated this container request.",
4262           "type": "string"
4263         },
4264         "name": {
4265           "description": "The name of this container request assigned by a user.",
4266           "type": "string"
4267         },
4268         "description": {
4269           "description": "A longer description of this container request assigned by a user.",
4270           "type": "text"
4271         },
4272         "properties": {
4273           "description": "A hash of arbitrary metadata for this container request.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4274           "type": "Hash"
4275         },
4276         "state": {
4277           "description": "A string indicating where this container request is in its lifecycle.\nPossible values are:\n\n  * `\"Uncommitted\"` --- The container request has not been finalized and can still be edited.\n  * `\"Committed\"` --- The container request is ready to be fulfilled.\n  * `\"Final\"` --- The container request has been fulfilled or cancelled.\n\n",
4278           "type": "string"
4279         },
4280         "requesting_container_uuid": {
4281           "description": "The UUID of the container that created this container request, if any.",
4282           "type": "string"
4283         },
4284         "container_uuid": {
4285           "description": "The UUID of the container that fulfills this container request, if any.",
4286           "type": "string"
4287         },
4288         "container_count_max": {
4289           "description": "An integer that defines the maximum number of times Arvados should attempt\nto dispatch a container to fulfill this container request.",
4290           "type": "integer"
4291         },
4292         "mounts": {
4293           "description": "A hash where each key names a directory inside this container, and its\nvalue is an object that defines the mount source for that directory. Refer\nto the [mount types reference][] for details.\n\n[mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types\n\n",
4294           "type": "Hash"
4295         },
4296         "runtime_constraints": {
4297           "description": "A hash that identifies compute resources this container requires to run\nsuccessfully. See the [runtime constraints reference][] for details.\n\n[runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints\n\n",
4298           "type": "Hash"
4299         },
4300         "container_image": {
4301           "description": "The portable data hash of the Arvados collection that contains the image\nto use for this container.",
4302           "type": "string"
4303         },
4304         "environment": {
4305           "description": "A hash of string keys and values that defines the environment variables\nfor the dispatcher to set when it executes this container.",
4306           "type": "Hash"
4307         },
4308         "cwd": {
4309           "description": "A string that the defines the working directory that the dispatcher should\nuse when it executes the command inside this container.",
4310           "type": "string"
4311         },
4312         "command": {
4313           "description": "An array of strings that defines the command that the dispatcher should\nexecute inside this container.",
4314           "type": "Array"
4315         },
4316         "output_path": {
4317           "description": "A string that defines the file or directory path where the command\nwrites output that should be saved from this container.",
4318           "type": "string"
4319         },
4320         "priority": {
4321           "description": "An integer between 0 and 1000 (inclusive) that represents this container request's\nscheduling priority. 0 represents a request to be cancelled. Higher\nvalues represent higher priority. Refer to the [priority reference][] for details.\n\n[priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority\n\n",
4322           "type": "integer"
4323         },
4324         "expires_at": {
4325           "description": "The time after which this container request will no longer be fulfilled. The string encodes a UTC date and time in ISO 8601 format.",
4326           "type": "datetime"
4327         },
4328         "filters": {
4329           "description": "Filters that limit which existing containers are eligible to satisfy this\ncontainer request. This attribute is not implemented yet and should be null.",
4330           "type": "text"
4331         },
4332         "container_count": {
4333           "description": "An integer that records how many times Arvados has attempted to dispatch\na container to fulfill this container request.",
4334           "type": "integer"
4335         },
4336         "use_existing": {
4337           "description": "A boolean flag. If set, Arvados may choose to satisfy this container\nrequest with an eligible container that already exists. Otherwise, Arvados will\nsatisfy this container request with a newer container, which will usually result\nin the container running again.",
4338           "type": "boolean"
4339         },
4340         "scheduling_parameters": {
4341           "description": "A hash of scheduling parameters that should be passed to the underlying\ndispatcher when this container is run.\nSee the [scheduling parameters reference][] for details.\n\n[scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters\n\n",
4342           "type": "Hash"
4343         },
4344         "output_uuid": {
4345           "description": "The UUID of the Arvados collection that contains output for all the\ncontainer(s) that were dispatched to fulfill this container request.",
4346           "type": "string"
4347         },
4348         "log_uuid": {
4349           "description": "The UUID of the Arvados collection that contains logs for all the\ncontainer(s) that were dispatched to fulfill this container request.",
4350           "type": "string"
4351         },
4352         "output_name": {
4353           "description": "The name to set on the output collection of this container request.",
4354           "type": "string"
4355         },
4356         "output_ttl": {
4357           "description": "An integer in seconds. If greater than zero, when an output collection is\ncreated for this container request, its `expires_at` attribute will be set this\nfar in the future.",
4358           "type": "integer"
4359         },
4360         "output_storage_classes": {
4361           "description": "An array of strings identifying the storage class(es) that should be set\non the output collection of this container request. Storage classes are configured by\nthe cluster administrator.",
4362           "type": "Array"
4363         },
4364         "output_properties": {
4365           "description": "A hash of arbitrary metadata to set on the output collection of this container request.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4366           "type": "Hash"
4367         },
4368         "cumulative_cost": {
4369           "description": "A float with the estimated cost of all cloud instances used to run\ncontainer(s) to fulfill this container request and their subrequests.\nThe value is `0` if cost estimation is not available on this cluster.",
4370           "type": "float"
4371         },
4372         "output_glob": {
4373           "description": "An array of strings of shell-style glob patterns that define which file(s)\nand subdirectory(ies) under the `output_path` directory should be recorded in\nthe container's final output. Refer to the [glob patterns reference][] for details.\n\n[glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns\n\n",
4374           "type": "Array"
4375         }
4376       }
4377     },
4378     "GroupList": {
4379       "id": "GroupList",
4380       "description": "A list of Group objects.",
4381       "type": "object",
4382       "properties": {
4383         "kind": {
4384           "type": "string",
4385           "description": "Object type. Always arvados#groupList.",
4386           "default": "arvados#groupList"
4387         },
4388         "etag": {
4389           "type": "string",
4390           "description": "List cache version."
4391         },
4392         "items": {
4393           "type": "array",
4394           "description": "An array of matching Group objects.",
4395           "items": {
4396             "$ref": "Group"
4397           }
4398         }
4399       }
4400     },
4401     "Group": {
4402       "id": "Group",
4403       "description": "Arvados group\n\nGroups provide a way to organize users or data together, depending on their\n`group_class`.",
4404       "type": "object",
4405       "uuidPrefix": "j7d0g",
4406       "properties": {
4407         "etag": {
4408           "type": "string",
4409           "description": "Object cache version."
4410         },
4411         "uuid": {
4412           "type": "string",
4413           "description": "This group's Arvados UUID, like `zzzzz-j7d0g-12345abcde67890`."
4414         },
4415         "owner_uuid": {
4416           "description": "The UUID of the user or group that owns this group.",
4417           "type": "string"
4418         },
4419         "created_at": {
4420           "description": "The time this group was created. The string encodes a UTC date and time in ISO 8601 format.",
4421           "type": "datetime"
4422         },
4423         "modified_by_user_uuid": {
4424           "description": "The UUID of the user that last updated this group.",
4425           "type": "string"
4426         },
4427         "modified_at": {
4428           "description": "The time this group was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4429           "type": "datetime"
4430         },
4431         "name": {
4432           "description": "The name of this group assigned by a user.",
4433           "type": "string"
4434         },
4435         "description": {
4436           "description": "A longer description of this group assigned by a user.",
4437           "type": "string"
4438         },
4439         "group_class": {
4440           "description": "A string representing which type of group this is. One of:\n\n  * `\"filter\"` --- A virtual project whose contents are selected dynamically by filters.\n  * `\"project\"` --- An Arvados project that can contain collections,\n    container records, workflows, and subprojects.\n  * `\"role\"` --- A group of users that can be granted permissions in Arvados.\n\n",
4441           "type": "string"
4442         },
4443         "trash_at": {
4444           "description": "The time this group will be trashed. The string encodes a UTC date and time in ISO 8601 format.",
4445           "type": "datetime"
4446         },
4447         "is_trashed": {
4448           "description": "A boolean flag to indicate whether or not this group is trashed.",
4449           "type": "boolean"
4450         },
4451         "delete_at": {
4452           "description": "The time this group will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format.",
4453           "type": "datetime"
4454         },
4455         "properties": {
4456           "description": "A hash of arbitrary metadata for this group.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4457           "type": "Hash"
4458         },
4459         "frozen_by_uuid": {
4460           "description": "The UUID of the user that has frozen this group, if any. Frozen projects\ncannot have their contents or metadata changed, even by admins.",
4461           "type": "string"
4462         }
4463       }
4464     },
4465     "KeepServiceList": {
4466       "id": "KeepServiceList",
4467       "description": "A list of KeepService objects.",
4468       "type": "object",
4469       "properties": {
4470         "kind": {
4471           "type": "string",
4472           "description": "Object type. Always arvados#keepServiceList.",
4473           "default": "arvados#keepServiceList"
4474         },
4475         "etag": {
4476           "type": "string",
4477           "description": "List cache version."
4478         },
4479         "items": {
4480           "type": "array",
4481           "description": "An array of matching KeepService objects.",
4482           "items": {
4483             "$ref": "KeepService"
4484           }
4485         }
4486       }
4487     },
4488     "KeepService": {
4489       "id": "KeepService",
4490       "description": "Arvados Keep service\n\nThis resource stores information about a single Keep service in this Arvados\ncluster that clients can contact to retrieve and store data.",
4491       "type": "object",
4492       "uuidPrefix": "bi6l4",
4493       "properties": {
4494         "etag": {
4495           "type": "string",
4496           "description": "Object cache version."
4497         },
4498         "uuid": {
4499           "type": "string",
4500           "description": "This Keep service's Arvados UUID, like `zzzzz-bi6l4-12345abcde67890`."
4501         },
4502         "owner_uuid": {
4503           "description": "The UUID of the user or group that owns this Keep service.",
4504           "type": "string"
4505         },
4506         "modified_by_user_uuid": {
4507           "description": "The UUID of the user that last updated this Keep service.",
4508           "type": "string"
4509         },
4510         "modified_at": {
4511           "description": "The time this Keep service was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4512           "type": "datetime"
4513         },
4514         "service_host": {
4515           "description": "The DNS hostname of this Keep service.",
4516           "type": "string"
4517         },
4518         "service_port": {
4519           "description": "The TCP port where this Keep service listens.",
4520           "type": "integer"
4521         },
4522         "service_ssl_flag": {
4523           "description": "A boolean flag that indicates whether or not this Keep service uses TLS/SSL.",
4524           "type": "boolean"
4525         },
4526         "service_type": {
4527           "description": "A string that describes which type of Keep service this is. One of:\n\n  * `\"disk\"` --- A service that stores blocks on a local filesystem.\n  * `\"blob\"` --- A service that stores blocks in a cloud object store.\n  * `\"proxy\"` --- A keepproxy service.\n\n",
4528           "type": "string"
4529         },
4530         "created_at": {
4531           "description": "The time this Keep service was created. The string encodes a UTC date and time in ISO 8601 format.",
4532           "type": "datetime"
4533         },
4534         "read_only": {
4535           "description": "A boolean flag. If set, this Keep service does not accept requests to write data\nblocks; it only serves blocks it already has.",
4536           "type": "boolean"
4537         }
4538       }
4539     },
4540     "LinkList": {
4541       "id": "LinkList",
4542       "description": "A list of Link objects.",
4543       "type": "object",
4544       "properties": {
4545         "kind": {
4546           "type": "string",
4547           "description": "Object type. Always arvados#linkList.",
4548           "default": "arvados#linkList"
4549         },
4550         "etag": {
4551           "type": "string",
4552           "description": "List cache version."
4553         },
4554         "items": {
4555           "type": "array",
4556           "description": "An array of matching Link objects.",
4557           "items": {
4558             "$ref": "Link"
4559           }
4560         }
4561       }
4562     },
4563     "Link": {
4564       "id": "Link",
4565       "description": "Arvados object link\n\nA link provides a way to define relationships between Arvados objects,\ndepending on their `link_class`.",
4566       "type": "object",
4567       "uuidPrefix": "o0j2j",
4568       "properties": {
4569         "etag": {
4570           "type": "string",
4571           "description": "Object cache version."
4572         },
4573         "uuid": {
4574           "type": "string",
4575           "description": "This link's Arvados UUID, like `zzzzz-o0j2j-12345abcde67890`."
4576         },
4577         "owner_uuid": {
4578           "description": "The UUID of the user or group that owns this link.",
4579           "type": "string"
4580         },
4581         "created_at": {
4582           "description": "The time this link was created. The string encodes a UTC date and time in ISO 8601 format.",
4583           "type": "datetime"
4584         },
4585         "modified_by_user_uuid": {
4586           "description": "The UUID of the user that last updated this link.",
4587           "type": "string"
4588         },
4589         "modified_at": {
4590           "description": "The time this link was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4591           "type": "datetime"
4592         },
4593         "tail_uuid": {
4594           "description": "The UUID of the Arvados object that is the target of this relationship.",
4595           "type": "string"
4596         },
4597         "link_class": {
4598           "description": "A string that defines which kind of link this is. One of:\n\n  * `\"permission\"` --- This link grants a permission to the user or group\n    referenced by `head_uuid` to the object referenced by `tail_uuid`. The\n    access level is set by `name`.\n  * `\"star\"` --- This link represents a \"favorite.\" The user referenced\n    by `head_uuid` wants quick access to the object referenced by `tail_uuid`.\n  * `\"tag\"` --- This link represents an unstructured metadata tag. The object\n    referenced by `tail_uuid` has the tag defined by `name`.\n\n",
4599           "type": "string"
4600         },
4601         "name": {
4602           "description": "The primary value of this link. For `\"permission\"` links, this is one of\n`\"can_read\"`, `\"can_write\"`, or `\"can_manage\"`.",
4603           "type": "string"
4604         },
4605         "head_uuid": {
4606           "description": "The UUID of the Arvados object that is the originator or actor in this\nrelationship. May be null.",
4607           "type": "string"
4608         },
4609         "properties": {
4610           "description": "A hash of arbitrary metadata for this link.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4611           "type": "Hash"
4612         }
4613       }
4614     },
4615     "LogList": {
4616       "id": "LogList",
4617       "description": "A list of Log objects.",
4618       "type": "object",
4619       "properties": {
4620         "kind": {
4621           "type": "string",
4622           "description": "Object type. Always arvados#logList.",
4623           "default": "arvados#logList"
4624         },
4625         "etag": {
4626           "type": "string",
4627           "description": "List cache version."
4628         },
4629         "items": {
4630           "type": "array",
4631           "description": "An array of matching Log objects.",
4632           "items": {
4633             "$ref": "Log"
4634           }
4635         }
4636       }
4637     },
4638     "Log": {
4639       "id": "Log",
4640       "description": "Arvados log record\n\nThis resource represents a single log record about an event in this Arvados\ncluster. Some individual Arvados services create log records. Users can also\ncreate custom logs.",
4641       "type": "object",
4642       "uuidPrefix": "57u5n",
4643       "properties": {
4644         "etag": {
4645           "type": "string",
4646           "description": "Object cache version."
4647         },
4648         "id": {
4649           "description": "The serial number of this log. You can use this in filters to query logs\nthat were created before/after another.",
4650           "type": "integer"
4651         },
4652         "uuid": {
4653           "type": "string",
4654           "description": "This log's Arvados UUID, like `zzzzz-57u5n-12345abcde67890`."
4655         },
4656         "owner_uuid": {
4657           "description": "The UUID of the user or group that owns this log.",
4658           "type": "string"
4659         },
4660         "modified_by_user_uuid": {
4661           "description": "The UUID of the user that last updated this log.",
4662           "type": "string"
4663         },
4664         "object_uuid": {
4665           "description": "The UUID of the Arvados object that this log pertains to, such as a user\nor container.",
4666           "type": "string"
4667         },
4668         "event_at": {
4669           "description": " The string encodes a UTC date and time in ISO 8601 format.",
4670           "type": "datetime"
4671         },
4672         "event_type": {
4673           "description": "An arbitrary short string that classifies what type of log this is.",
4674           "type": "string"
4675         },
4676         "summary": {
4677           "description": "A text string that describes the logged event. This is the primary\nattribute for simple logs.",
4678           "type": "text"
4679         },
4680         "properties": {
4681           "description": "A hash of arbitrary metadata for this log.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4682           "type": "Hash"
4683         },
4684         "created_at": {
4685           "description": "The time this log was created. The string encodes a UTC date and time in ISO 8601 format.",
4686           "type": "datetime"
4687         },
4688         "modified_at": {
4689           "description": "The time this log was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4690           "type": "datetime"
4691         },
4692         "object_owner_uuid": {
4693           "description": "The `owner_uuid` of the object referenced by `object_uuid` at the time\nthis log was created.",
4694           "type": "string"
4695         }
4696       }
4697     },
4698     "UserList": {
4699       "id": "UserList",
4700       "description": "A list of User objects.",
4701       "type": "object",
4702       "properties": {
4703         "kind": {
4704           "type": "string",
4705           "description": "Object type. Always arvados#userList.",
4706           "default": "arvados#userList"
4707         },
4708         "etag": {
4709           "type": "string",
4710           "description": "List cache version."
4711         },
4712         "items": {
4713           "type": "array",
4714           "description": "An array of matching User objects.",
4715           "items": {
4716             "$ref": "User"
4717           }
4718         }
4719       }
4720     },
4721     "User": {
4722       "id": "User",
4723       "description": "Arvados user\n\nA user represents a single individual or role who may be authorized to access\nthis Arvados cluster.",
4724       "type": "object",
4725       "uuidPrefix": "tpzed",
4726       "properties": {
4727         "etag": {
4728           "type": "string",
4729           "description": "Object cache version."
4730         },
4731         "uuid": {
4732           "type": "string",
4733           "description": "This user's Arvados UUID, like `zzzzz-tpzed-12345abcde67890`."
4734         },
4735         "owner_uuid": {
4736           "description": "The UUID of the user or group that owns this user.",
4737           "type": "string"
4738         },
4739         "created_at": {
4740           "description": "The time this user was created. The string encodes a UTC date and time in ISO 8601 format.",
4741           "type": "datetime"
4742         },
4743         "modified_by_user_uuid": {
4744           "description": "The UUID of the user that last updated this user.",
4745           "type": "string"
4746         },
4747         "modified_at": {
4748           "description": "The time this user was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4749           "type": "datetime"
4750         },
4751         "email": {
4752           "description": "This user's email address.",
4753           "type": "string"
4754         },
4755         "first_name": {
4756           "description": "This user's first name.",
4757           "type": "string"
4758         },
4759         "last_name": {
4760           "description": "This user's last name.",
4761           "type": "string"
4762         },
4763         "identity_url": {
4764           "description": "A URL that represents this user with the cluster's identity provider.",
4765           "type": "string"
4766         },
4767         "is_admin": {
4768           "description": "A boolean flag. If set, this user is an administrator of the Arvados\ncluster, and automatically passes most permissions checks.",
4769           "type": "boolean"
4770         },
4771         "prefs": {
4772           "description": "A hash that stores cluster-wide user preferences.",
4773           "type": "Hash"
4774         },
4775         "is_active": {
4776           "description": "A boolean flag. If unset, this user is not permitted to make any Arvados\nAPI requests.",
4777           "type": "boolean"
4778         },
4779         "username": {
4780           "description": "This user's Unix username on virtual machines.",
4781           "type": "string"
4782         }
4783       }
4784     },
4785     "UserAgreementList": {
4786       "id": "UserAgreementList",
4787       "description": "A list of UserAgreement objects.",
4788       "type": "object",
4789       "properties": {
4790         "kind": {
4791           "type": "string",
4792           "description": "Object type. Always arvados#userAgreementList.",
4793           "default": "arvados#userAgreementList"
4794         },
4795         "etag": {
4796           "type": "string",
4797           "description": "List cache version."
4798         },
4799         "items": {
4800           "type": "array",
4801           "description": "An array of matching UserAgreement objects.",
4802           "items": {
4803             "$ref": "UserAgreement"
4804           }
4805         }
4806       }
4807     },
4808     "UserAgreement": {
4809       "id": "UserAgreement",
4810       "description": "Arvados user agreement\n\nA user agreement is a collection with terms that users must agree to before\nthey can use this Arvados cluster.",
4811       "type": "object",
4812       "uuidPrefix": "gv0sa",
4813       "properties": {
4814         "etag": {
4815           "type": "string",
4816           "description": "Object cache version."
4817         },
4818         "owner_uuid": {
4819           "description": "The UUID of the user or group that owns this user agreement.",
4820           "type": "string"
4821         },
4822         "created_at": {
4823           "description": "The time this user agreement was created. The string encodes a UTC date and time in ISO 8601 format.",
4824           "type": "datetime"
4825         },
4826         "modified_by_user_uuid": {
4827           "description": "The UUID of the user that last updated this user agreement.",
4828           "type": "string"
4829         },
4830         "modified_at": {
4831           "description": "The time this user agreement was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4832           "type": "datetime"
4833         },
4834         "portable_data_hash": {
4835           "description": "The portable data hash of this user agreement. This string provides a unique\nand stable reference to these contents.",
4836           "type": "string"
4837         },
4838         "replication_desired": {
4839           "description": "The number of copies that should be made for data in this user agreement.",
4840           "type": "integer"
4841         },
4842         "replication_confirmed_at": {
4843           "description": "The last time the cluster confirmed that it met `replication_confirmed`\nfor this user agreement. The string encodes a UTC date and time in ISO 8601 format.",
4844           "type": "datetime"
4845         },
4846         "replication_confirmed": {
4847           "description": "The number of copies of data in this user agreement that the cluster has confirmed\nexist in storage.",
4848           "type": "integer"
4849         },
4850         "uuid": {
4851           "type": "string",
4852           "description": "This user agreement's Arvados UUID, like `zzzzz-gv0sa-12345abcde67890`."
4853         },
4854         "manifest_text": {
4855           "description": "The manifest text that describes how files are constructed from data blocks\nin this user agreement. Refer to the [manifest format][] reference for details.\n\n[manifest format]: https://doc.arvados.org/architecture/manifest-format.html\n\n",
4856           "type": "text"
4857         },
4858         "name": {
4859           "description": "The name of this user agreement assigned by a user.",
4860           "type": "string"
4861         },
4862         "description": {
4863           "description": "A longer description of this user agreement assigned by a user.",
4864           "type": "string"
4865         },
4866         "properties": {
4867           "description": "A hash of arbitrary metadata for this user agreement.\nSome keys may be reserved by Arvados or defined by a configured vocabulary.\nRefer to the [metadata properties reference][] for details.\n\n[metadata properties reference]: https://doc.arvados.org/api/properties.html\n\n",
4868           "type": "Hash"
4869         },
4870         "delete_at": {
4871           "description": "The time this user agreement will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format.",
4872           "type": "datetime"
4873         },
4874         "trash_at": {
4875           "description": "The time this user agreement will be trashed. The string encodes a UTC date and time in ISO 8601 format.",
4876           "type": "datetime"
4877         },
4878         "is_trashed": {
4879           "description": "A boolean flag to indicate whether or not this user agreement is trashed.",
4880           "type": "boolean"
4881         },
4882         "storage_classes_desired": {
4883           "description": "An array of strings identifying the storage class(es) that should be used\nfor data in this user agreement. Storage classes are configured by the cluster administrator.",
4884           "type": "Array"
4885         },
4886         "storage_classes_confirmed": {
4887           "description": "An array of strings identifying the storage class(es) the cluster has\nconfirmed have a copy of this user agreement's data.",
4888           "type": "Array"
4889         },
4890         "storage_classes_confirmed_at": {
4891           "description": "The last time the cluster confirmed that data was stored on the storage\nclass(es) in `storage_classes_confirmed`. The string encodes a UTC date and time in ISO 8601 format.",
4892           "type": "datetime"
4893         },
4894         "current_version_uuid": {
4895           "description": "The UUID of the current version of this user agreement.",
4896           "type": "string"
4897         },
4898         "version": {
4899           "description": "An integer that counts which version of a user agreement this record\nrepresents. Refer to [collection versioning][] for details. This attribute is\nread-only.\n\n[collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html\n\n",
4900           "type": "integer"
4901         },
4902         "preserve_version": {
4903           "description": "A boolean flag to indicate whether this specific version of this user agreement\nshould be persisted in cluster storage.",
4904           "type": "boolean"
4905         },
4906         "file_count": {
4907           "description": "The number of files represented in this user agreement's `manifest_text`.\nThis attribute is read-only.",
4908           "type": "integer"
4909         },
4910         "file_size_total": {
4911           "description": "The total size in bytes of files represented in this user agreement's `manifest_text`.\nThis attribute is read-only.",
4912           "type": "integer"
4913         }
4914       }
4915     },
4916     "VirtualMachineList": {
4917       "id": "VirtualMachineList",
4918       "description": "A list of VirtualMachine objects.",
4919       "type": "object",
4920       "properties": {
4921         "kind": {
4922           "type": "string",
4923           "description": "Object type. Always arvados#virtualMachineList.",
4924           "default": "arvados#virtualMachineList"
4925         },
4926         "etag": {
4927           "type": "string",
4928           "description": "List cache version."
4929         },
4930         "items": {
4931           "type": "array",
4932           "description": "An array of matching VirtualMachine objects.",
4933           "items": {
4934             "$ref": "VirtualMachine"
4935           }
4936         }
4937       }
4938     },
4939     "VirtualMachine": {
4940       "id": "VirtualMachine",
4941       "description": "Arvados virtual machine (\"shell node\")\n\nThis resource stores information about a virtual machine or \"shell node\"\nhosted on this Arvados cluster where users can log in and use preconfigured\nArvados client tools.",
4942       "type": "object",
4943       "uuidPrefix": "2x53u",
4944       "properties": {
4945         "etag": {
4946           "type": "string",
4947           "description": "Object cache version."
4948         },
4949         "uuid": {
4950           "type": "string",
4951           "description": "This virtual machine's Arvados UUID, like `zzzzz-2x53u-12345abcde67890`."
4952         },
4953         "owner_uuid": {
4954           "description": "The UUID of the user or group that owns this virtual machine.",
4955           "type": "string"
4956         },
4957         "modified_by_user_uuid": {
4958           "description": "The UUID of the user that last updated this virtual machine.",
4959           "type": "string"
4960         },
4961         "modified_at": {
4962           "description": "The time this virtual machine was last updated. The string encodes a UTC date and time in ISO 8601 format.",
4963           "type": "datetime"
4964         },
4965         "hostname": {
4966           "description": "The DNS hostname where users should access this virtual machine.",
4967           "type": "string"
4968         },
4969         "created_at": {
4970           "description": "The time this virtual machine was created. The string encodes a UTC date and time in ISO 8601 format.",
4971           "type": "datetime"
4972         }
4973       }
4974     },
4975     "WorkflowList": {
4976       "id": "WorkflowList",
4977       "description": "A list of Workflow objects.",
4978       "type": "object",
4979       "properties": {
4980         "kind": {
4981           "type": "string",
4982           "description": "Object type. Always arvados#workflowList.",
4983           "default": "arvados#workflowList"
4984         },
4985         "etag": {
4986           "type": "string",
4987           "description": "List cache version."
4988         },
4989         "items": {
4990           "type": "array",
4991           "description": "An array of matching Workflow objects.",
4992           "items": {
4993             "$ref": "Workflow"
4994           }
4995         }
4996       }
4997     },
4998     "Workflow": {
4999       "id": "Workflow",
5000       "description": "Arvados workflow\n\nA workflow contains workflow definition source code that Arvados can execute\nalong with associated metadata for users.",
5001       "type": "object",
5002       "uuidPrefix": "7fd4e",
5003       "properties": {
5004         "etag": {
5005           "type": "string",
5006           "description": "Object cache version."
5007         },
5008         "uuid": {
5009           "type": "string",
5010           "description": "This workflow's Arvados UUID, like `zzzzz-7fd4e-12345abcde67890`."
5011         },
5012         "owner_uuid": {
5013           "description": "The UUID of the user or group that owns this workflow.",
5014           "type": "string"
5015         },
5016         "created_at": {
5017           "description": "The time this workflow was created. The string encodes a UTC date and time in ISO 8601 format.",
5018           "type": "datetime"
5019         },
5020         "modified_at": {
5021           "description": "The time this workflow was last updated. The string encodes a UTC date and time in ISO 8601 format.",
5022           "type": "datetime"
5023         },
5024         "modified_by_user_uuid": {
5025           "description": "The UUID of the user that last updated this workflow.",
5026           "type": "string"
5027         },
5028         "name": {
5029           "description": "The name of this workflow assigned by a user.",
5030           "type": "string"
5031         },
5032         "description": {
5033           "description": "A longer description of this workflow assigned by a user.",
5034           "type": "text"
5035         },
5036         "definition": {
5037           "description": "A string with the CWL source of this workflow.",
5038           "type": "text"
5039         }
5040       }
5041     }
5042   },
5043   "servicePath": "arvados/v1/",
5044   "title": "Arvados API",
5045   "version": "v1"
5046 }