indexes

Find indexes

Lists all existing indexes.

Request

get
/indexes

Response

{
  "status": "200"
}

Get an index

Fetches the details for an index.

Errors

StatusDescription
404 Not found

Request

get
/indexes/{index_id}

Response

{
  "example": {
    "change_count": 2,
    "contributors": [
      {
        "count": 1,
        "id": "fred"
      },
      {
        "count": 3,
        "id": "igboyes"
      }
    ],
    "created_at": "2015-10-06T20:00:00Z",
    "files": [],
    "has_files": true,
    "id": "foo",
    "job": {
      "id": "foo"
    },
    "manifest": [],
    "modified_otu_count": 2,
    "otus": [
      {
        "change_count": 1,
        "id": "kjs8sa99",
        "name": "Foo"
      },
      {
        "change_count": 3,
        "id": "zxbbvngc",
        "name": "Test"
      }
    ],
    "ready": false,
    "reference": {
      "id": "foo"
    },
    "user": {
      "administrator": false,
      "handle": "leeashley",
      "id": "bf1b993c"
    },
    "version": 0
  },
  "status": "200"
}

Download index files

Downloads files relating to a given index.

Errors

StatusDescription
404 Not found

Request

get
/indexes/{index_id}/files/{filename}

Response

{
  "status": "200"
}

List history

Lists history changes for a specific index.

Errors

StatusDescription
404 Not found

Request

get
/indexes/{index_id}/history

Response

{
  "example": [
    {
      "created_at": "2022-01-28T23:28:53.881000Z",
      "description": "Removed Betaflexivirus from Camelia #1 (BFV_CAM1)",
      "id": "1wfc5x6e.removed",
      "index": {
        "id": "s7frhn8n",
        "version": 1
      },
      "method_name": "remove",
      "otu": {
        "id": "1wfc5x6e",
        "name": "Betaflexivirus from Camelia #1",
        "version": 4
      },
      "reference": {
        "id": "pat6xdn3"
      },
      "user": {
        "administrator": true,
        "handle": "igboyes",
        "id": "igboyes"
      }
    }
  ],
  "status": "200"
}