Using the external API

{"header":{"message":"Adds documentation for the external API (#441)","description":"Documents all the endpoints that can be used to retrieve data from\nthe API without authenticating.\n\nAuthentication and manipulating data with the API is not documented.","timestamp":"2017-04-01T09:20:49Z","authors":[{"email":"rzetterberg@users.noreply.github.com","name":"Richard Zetterberg"}]},"hash":"GRMV5GEWXL5HRCQ5AST22ATEPO3VNF4TSJWLYT3J5GPCM2CGRK4AC","authors":[],"deps":{"hashes":[["GRMV5GEWXL5HRCQ5AST22ATEPO3VNF4TSJWLYT3J5GPCM2CGRK4AC","Adds documentation for the external API (#441)"],["AA",null],["DWQCLOPQCZENDPZ3JKIL4T2XU3IPT5BU6VKTOMS3PXZDUL3KDZSQC","Tweaks for nix-shell"],["6A6CZ7SC2VGEGRC5LSNTDDM3LFWVYO6Z6QNDF74SBJWO5P6T3ARQC","draft manual"],["5AKAE3R6RZMDWN2UMNYCB73Z2FEE5WJUCEY4YAAOHGAKHVJQPO7QC","start of hydra manual"],["PKE6I67S7TDGKEFCKIQZOZ5PSDZXCSPOQGSKDAE5NST3NOOLRUXAC","doc: Import the \"Creating Projects\" chapter by Visser & Dolstra."]],"deps":["DWQCLOPQCZENDPZ3JKIL4T2XU3IPT5BU6VKTOMS3PXZDUL3KDZSQC"],"known":[]},"hunks":[{"FileAdd":{"meta":{"basename":"api.xml","metadata":0},"context":[{"change":4,"pos":18}],"contents":[{"Add":""},{"Add":""},{"Add":" Using the external API"},{"Add":""},{"Add":" "},{"Add":" To be able to create integrations with other services, Hydra exposes"},{"Add":" an external API that you can manage projects with."},{"Add":" "},{"Add":""},{"Add":" "},{"Add":" The API is accessed over HTTP(s) where all data is sent and received"},{"Add":" as JSON."},{"Add":" "},{"Add":""},{"Add":" "},{"Add":" Creating resources requires the caller to be authenticated, while"},{"Add":" retrieving resources does not."},{"Add":" "},{"Add":""},{"Add":" "},{"Add":" The API does not have a separate URL structure for it's endpoints."},{"Add":" Instead you request the pages of the web interface as"},{"Add":" application/json to use the API."},{"Add":" "},{"Add":""},{"Add":"

"},{"Add":" List projects"},{"Add":""},{"Add":" "},{"Add":" To list all the projects of the Hydra install:"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET /"},{"Add":"Accept: application/json"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" This will give you a list of projects, where each"},{"Add":" project contains general information and a list"},{"Add":" of its job sets."},{"Add":" "},{"Add":""},{"Add":" "},{"Add":" Example"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"curl -i -H 'Accept: application/json' \\"},{"Add":" https://hydra.nixos.org"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" Note: this response is truncated"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET https://hydra.nixos.org/"},{"Add":"HTTP/1.1 200 OK"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":"["},{"Add":" {"},{"Add":" \"displayname\": \"Acoda\","},{"Add":" \"name\": \"acoda\","},{"Add":" \"releases\": [],"},{"Add":" \"description\": \"Acoda is a tool set for automatic data migration along an evolving data model\","},{"Add":" \"enabled\": 0,"},{"Add":" \"owner\": \"sander\","},{"Add":" \"hidden\": 1,"},{"Add":" \"jobsets\": ["},{"Add":" \"trunk\""},{"Add":" ]"},{"Add":" },"},{"Add":" {"},{"Add":" \"displayname\": \"cabal2nix\","},{"Add":" \"name\": \"cabal2nix\","},{"Add":" \"releases\": [],"},{"Add":" \"description\": \"Convert Cabal files into Nix build instructions\","},{"Add":" \"enabled\": 0,"},{"Add":" \"owner\": \"simons@cryp.to\","},{"Add":" \"hidden\": 1,"},{"Add":" \"jobsets\": ["},{"Add":" \"master\""},{"Add":" ]"},{"Add":" }"},{"Add":"]"},{"Add":""},{"Add":"

"},{"Add":""},{"Add":"

"},{"Add":" Get a single project"},{"Add":""},{"Add":" "},{"Add":" To get a single project by identifier:"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET /project/:project-identifier"},{"Add":"Accept: application/json"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" Example"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"curl -i -H 'Accept: application/json' \\"},{"Add":" https://hydra.nixos.org/project/hydra"},{"Add":""},{"Add":""},{"Add":""},{"Add":"GET https://hydra.nixos.org/project/hydra"},{"Add":"HTTP/1.1 200 OK"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":"{"},{"Add":" \"description\": \"Hydra, the Nix-based continuous build system\","},{"Add":" \"hidden\": 0,"},{"Add":" \"displayname\": \"Hydra\","},{"Add":" \"jobsets\": ["},{"Add":" \"hydra-master\","},{"Add":" \"hydra-ant-logger-trunk\","},{"Add":" \"master\","},{"Add":" \"build-ng\""},{"Add":" ],"},{"Add":" \"name\": \"hydra\","},{"Add":" \"enabled\": 1,"},{"Add":" \"owner\": \"eelco\","},{"Add":" \"releases\": []"},{"Add":"}"},{"Add":""},{"Add":""},{"Add":"

"},{"Add":""},{"Add":"

"},{"Add":" Get a single job set"},{"Add":""},{"Add":" "},{"Add":" To get a single job set by identifier:"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET /jobset/:project-identifier/:jobset-identifier"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" Example"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"curl -i -H 'Accept: application/json' \\"},{"Add":" https://hydra.nixos.org/jobset/hydra/build-ng"},{"Add":""},{"Add":""},{"Add":""},{"Add":"GET https://hydra.nixos.org/jobset/hydra/build-ng"},{"Add":"HTTP/1.1 200 OK"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":"{"},{"Add":" \"errormsg\": \"evaluation failed due to signal 9 (Killed)\","},{"Add":" \"fetcherrormsg\": null,"},{"Add":" \"nixexprpath\": \"release.nix\","},{"Add":" \"nixexprinput\": \"hydraSrc\","},{"Add":" \"emailoverride\": \"rob.vermaas@gmail.com, eelco.dolstra@logicblox.com\","},{"Add":" \"jobsetinputs\": {"},{"Add":" \"officialRelease\": {"},{"Add":" \"jobsetinputalts\": ["},{"Add":" \"false\""},{"Add":" ]"},{"Add":" },"},{"Add":" \"hydraSrc\": {"},{"Add":" \"jobsetinputalts\": ["},{"Add":" \"https://github.com/NixOS/hydra.git build-ng\""},{"Add":" ]"},{"Add":" },"},{"Add":" \"nixpkgs\": {"},{"Add":" \"jobsetinputalts\": ["},{"Add":" \"https://github.com/NixOS/nixpkgs.git release-14.12\""},{"Add":" ]"},{"Add":" }"},{"Add":" },"},{"Add":" \"enabled\": 0"},{"Add":"}"},{"Add":""},{"Add":"

"},{"Add":""},{"Add":"

"},{"Add":" List evaluations"},{"Add":""},{"Add":" "},{"Add":" To list the evaluations of a"},{"Add":" job set by identifier:"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET /jobset/:project-identifier/:jobset-identifier/evals"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" Example"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"curl -i -H 'Accept: application/json' \\"},{"Add":" https://hydra.nixos.org/jobset/hydra/build-ng/evals"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" Note: this response is truncated"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET https://hydra.nixos.org/jobset/hydra/build-ng/evals"},{"Add":"HTTP/1.1 200 OK"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":"{"},{"Add":" \"evals\": ["},{"Add":" {"},{"Add":" \"jobsetevalinputs\": {"},{"Add":" \"nixpkgs\": {"},{"Add":" \"dependency\": null,"},{"Add":" \"type\": \"git\","},{"Add":" \"value\": null,"},{"Add":" \"uri\": \"https://github.com/NixOS/nixpkgs.git\","},{"Add":" \"revision\": \"f60e48ce81b6f428d072d3c148f6f2e59f1dfd7a\""},{"Add":" },"},{"Add":" \"hydraSrc\": {"},{"Add":" \"dependency\": null,"},{"Add":" \"type\": \"git\","},{"Add":" \"value\": null,"},{"Add":" \"uri\": \"https://github.com/NixOS/hydra.git\","},{"Add":" \"revision\": \"48d6f0de2ab94f728d287b9c9670c4d237e7c0f6\""},{"Add":" },"},{"Add":" \"officialRelease\": {"},{"Add":" \"dependency\": null,"},{"Add":" \"value\": \"false\","},{"Add":" \"type\": \"boolean\","},{"Add":" \"uri\": null,"},{"Add":" \"revision\": null"},{"Add":" }"},{"Add":" },"},{"Add":" \"hasnewbuilds\": 1,"},{"Add":" \"builds\": ["},{"Add":" 24670686,"},{"Add":" 24670684,"},{"Add":" 24670685,"},{"Add":" 24670687"},{"Add":" ],"},{"Add":" \"id\": 1213758"},{"Add":" }"},{"Add":" ],"},{"Add":" \"first\": \"?page=1\","},{"Add":" \"last\": \"?page=1\""},{"Add":"}"},{"Add":""},{"Add":"

"},{"Add":""},{"Add":"

"},{"Add":" Get a single build"},{"Add":""},{"Add":" "},{"Add":" To get a single build by its id:"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"GET /build/:build-id"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":""},{"Add":" "},{"Add":" Example"},{"Add":" "},{"Add":""},{"Add":""},{"Add":"curl -i -H 'Accept: application/json' \\"},{"Add":" https://hydra.nixos.org/build/24670686"},{"Add":""},{"Add":""},{"Add":""},{"Add":"GET /build/24670686"},{"Add":"HTTP/1.1 200 OK"},{"Add":"Content-Type: application/json"},{"Add":""},{"Add":"{"},{"Add":" \"job\": \"tests.api.x86_64-linux\","},{"Add":" \"jobsetevals\": ["},{"Add":" 1213758"},{"Add":" ],"},{"Add":" \"buildstatus\": 0,"},{"Add":" \"buildmetrics\": null,"},{"Add":" \"project\": \"hydra\","},{"Add":" \"system\": \"x86_64-linux\","},{"Add":" \"priority\": 100,"},{"Add":" \"releasename\": null,"},{"Add":" \"starttime\": 1439402853,"},{"Add":" \"nixname\": \"vm-test-run-unnamed\","},{"Add":" \"timestamp\": 1439388618,"},{"Add":" \"id\": 24670686,"},{"Add":" \"stoptime\": 1439403403,"},{"Add":" \"jobset\": \"build-ng\","},{"Add":" \"buildoutputs\": {"},{"Add":" \"out\": {"},{"Add":" \"path\": \"/nix/store/lzrxkjc35mhp8w7r8h82g0ljyizfchma-vm-test-run-unnamed\""},{"Add":" }"},{"Add":" },"},{"Add":" \"buildproducts\": {"},{"Add":" \"1\": {"},{"Add":" \"path\": \"/nix/store/lzrxkjc35mhp8w7r8h82g0ljyizfchma-vm-test-run-unnamed\","},{"Add":" \"sha1hash\": null,"},{"Add":" \"defaultpath\": \"log.html\","},{"Add":" \"type\": \"report\","},{"Add":" \"sha256hash\": null,"},{"Add":" \"filesize\": null,"},{"Add":" \"name\": \"\","},{"Add":" \"subtype\": \"testlog\""},{"Add":" }"},{"Add":" },"},{"Add":" \"finished\": 1"},{"Add":"}"},{"Add":""},{"Add":"

"},{"Add":""},{"Add":""},{"Add":""},{"Add":""}]}},{"Edit":{"inode":{"change":5,"pos":1},"path":"doc/manual/manual.xml","line":66,"atom":{"NewVertex":{"up_context":[{"change":6,"pos":112}],"down_context":[{"change":2,"pos":318}],"flag":"BLOCK","start":7342,"end":7374,"inode":{"change":5,"pos":1}}},"contents":[{"Add":" "}]}}],"owner":"grahamc","repo":"hydra2","token":"J8T7vsBQjMjMjGKmMW91He+drB32WbS7R/fqMYzLh3s=","login":null}

…

Dependencies

Change contents