Legacy API Docs. These docs are for Virtool 4.4.0.

Indexes

Find

Requires read permission on reference

List all virus reference indexes. Takes no query or input.

GET

/api/indexes

Example

GET /api/indexes

Response

Status: 200 OK

{
  "documents": [
    {
      "version": 0,
      "created_at": "2018-02-01T00:28:49.798000Z",
      "virus_count": null,
      "ready": true,
      "has_files": true,
      "user": {
        "id": "igboyes"
      },
      "job": {
        "id": "wwssuhhy"
      },
      "id": "jiwncaqr"
    }
  ],
  "total_count": 1,
  "found_count": 1,
  "page_count": 1,
  "per_page": 15,
  "page": 1,
  "modified_virus_count": 0,
  "total_virus_count": 1419
}

Errors

None

List Latest Indexes

Requires read permission on reference

List the latest, ready index builds for all references.

GET

/api/indexes?ready=true

Example

GET /api/indexes?ready=true

Response

Status: 200 OK

[
  {
    "id": "0egezq4w",
    "version": 0,
    "reference": {
      "id": "nleoiawn",
      "name": "Plant Viruses"
    }
  },
  {
    "id": "nz6j0wwk",
    "version": 1,
    "reference": {
      "id": "mifz0ya0",
      "name": "Clone of Plant Viruses"
    }
  }
]

Get

Requires read permission on reference

Get the complete representation of an index.

GET

/api/indexes/:id

Example

GET /api/indexes/jiwncaqr

Response

Status: 200 OK

{
	"version": 0,
	"created_at": "2018-02-01T00:28:49.798000Z",
	"virus_count": null,
	"manifest": {
		"c93ec9a9": 0,
        ...
	},
	"ready": true,
	"has_files": true,
	"user": {
		"id": "igboyes"
	},
	"job": {
		"id": "wwssuhhy"
	},
	"id": "jiwncaqr",
	"contributors": [
		{
			"id": "igboyes",
			"count": 1419
		}
	],
	"viruses": [
		{
			"id": "c93ec9a9",
			"name": "Abaca bunchy top virus",
			"change_count": 1
		},
        ...
	],
	"change_count": 1419
}

Errors

Status	Message	Reason
404	Not found	index identified by `index_id` does not exist

Create

See References API Documentation

Find History

Requires read permission on reference

Find the virus changes that are included in a given index build.

GET

/api/indexes/:id/history

Example

GET /api/indexes/bznqwjsa/history

Response

Status: 200 OK

{
  "documents": [
    {
      "method_name": "remove_isolate",
      "description": "Removed Isolate Q1108",
      "created_at": "2018-02-06T22:02:43.533000Z",
      "virus": {
        "id": "c93ec9a9",
        "name": "Abaca bunchy top virus",
        "version": 1
      },
      "index": {
        "id": "bznqwjsa",
        "version": 1
      },
      "user": {
        "id": "igboyes"
      },
      "id": "c93ec9a9.1"
    }
  ],
  "total_count": 1420,
  "found_count": 1,
  "page_count": 1,
  "per_page": 15,
  "page": 1
}

Errors

Status	Message	Reason
404	Not found	index identified by `index_id` does not exist