Get project

3 minute read

GET /organizations/{organization_uuid}/projects/{uuid}

Gets a project by uuid.

Note that the following will only be populated for Basic projects:

  • setup_commands

  • environment_variables

  • test_commands

  • deployment_pipelines

Similarly, the following will only be returned for Pro projects:

  • aes_key

The configuration for deployment pipelines is either an array of strings (if it’s a custom script-type pipeline) or a JSON object (if it’s one of the pre-built deployments).

Authentication

  • OAuth2

OAuth2 scopes

  • project.read

Path parameters

Field nameTypeRequired

organization_uuid

string

X

uuid

string

X

Headers

Field nameTypeRequired

Authorization

string

X

Responses

CodeDatatype

201

Response schema

401

Error

403

Error

404

Error

500

Error

Response schema

  • Content type: application/json

  • Response schema type: object

Field nameType

aes_key

string

uuid

string

organization_uuid

string

authentication_user

string

name

string

repository_provider

string

ssh_key

string

repository_url

string

type

string Allowed values: basic, pro

created_at

string

updated_at

string

build_on_pr_only

boolean

branch_match

string Allowed values: include, exclude

branches

array[string]

setup_commands

array[string]

test_pipelines

array[object]

  • id

integer

  • name

string

  • commands

array[string]

team_ids

array[number]

notification_rules

array[object]

  • notifier

string Allowed values: email, slack, campfire, flowdock, webhook

  • target

string Allowed values: all, committer

  • branch

string

  • options

object

key

string

url

string

room

string

  • build_statuses

array[string] Allowed values: started, failed, success, recovered

  • branch_match

string Allowed values: exact, regex, wildcard

environment_variables

array[object]

  • name

string

  • value

string

deployment_pipelines

array[object]

  • id

integer

  • branch

object

branch_name

string

match_mode

string

  • config

object

  • position

integer

Response example

{
  "project": {
    "uuid": "019f9bcc-ce4b-4179-a533-c3995f4b6161",
    "name": "codeship/documentation",
    "type": "basic",
    "repository_url": "https://github.com/codeship/documentation",
    "repository_provider": "github",
    "authentication_user": "CodeShip Bot",
    "organization_uuid": "721cea10-b6a5-0104-5b93-5240c481c5a2",
    "notification_rules": [
      {
        "notifier": "github",
        "branch": null,
        "branch_match": "exact",
        "build_statuses": [
          "failed",
          "started",
          "recovered",
          "success"
        ],
        "target": "all",
        "options": {}
      },
      {
        "notifier": "email",
        "branch": null,
        "branch_match": "exact",
        "build_statuses": [
          "failed",
          "recovered"
        ],
        "target": "all",
        "options": {}
      }
    ],
    "ssh_key": "ssh-rsa EXAMPLE AAAAB3NzaC1yc2EAAAADAQABAAABAQC4AceKnURxK54HXUkxO52SETy7jsQZBV8biE/RtSZukz1uSj1/Y8cm99XGOiQiNnP3KI6KuUnsS/3LNZ0HX/y2Lqraju0Vvkh8Yn6klLEGgsFlNsw5RpS9Cb6CS+iF39tcP+N9s7bPV6a3mEY4Hx30rgTeydj2fcvuTp5gzwQ9c1HBeLq9U2rxcsvDIayHC8T6TeYOh0s33+dKTuZDGD5SzqbLDEMDcRyVsvyzg/GVnpOaJ24dAbD3lxQr4Z/EOBht3wKGuHb/P3L52Pp1mVZrzPpCBt4JBeMu/uGAafywNhIUEYFP0EMh30opiDANe2TBsacN4I7XoUEv0yHM1jYl Codeship/codeship/example",
    "aes_key": null,
    "created_at": "2017-07-28T22:03:16.480Z",
    "updated_at": "2017-09-18T16:14:43.093Z",
    "team_ids": [
      170524,
      202470
    ],
    "setup_commands": [],
    "deployment_pipelines": [
      {
        "branch": {
          "branch_name": "master",
          "match_mode": "exact"
        },
        "config": {
          "commands": [
            "echo \"look at me, i'm deploying!\""
          ]
        },
        "position": 1
      }
    ],
    "environment_variables": [],
    "test_pipelines": [
      {
        "name": "more testing",
        "commands": [
          "echo \"testing 2\""
        ]
      },
      {
        "name": "Test Commands",
        "commands": [
          "echo \"testing 1\""
        ]
      }
    ]
  }
}

Code examples

cURL
Go
Java
Node
PHP
Python
Ruby
C#
curl --request GET \
  --url https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161 \
  --header 'authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9' \
  --data '{}'
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("authorization", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161")
  .get()
  .addHeader("authorization", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9")
  .build();

Response response = client.newCall(request).execute();
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api.codeship.com",
  "port": null,
  "path": "/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161",
  "headers": {
    "authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write("{}");
req.end();
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "{}",
  CURLOPT_HTTPHEADER => array(
    "authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
import http.client

conn = http.client.HTTPSConnection("api.codeship.com")

payload = "{}"

headers = { 'authorization': "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" }

conn.request("GET", "/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
require 'uri'
require 'net/http'

url = URI("https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["authorization"] = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
request.body = "{}"

response = http.request(request)
puts response.read_body
var client = new RestClient("https://api.codeship.com/v2/organizations/721cea10-b6a5-0104-5b93-5240c481c5a2/projects/019f9bcc-ce4b-4179-a533-c3995f4b6161");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9");
request.AddParameter("undefined", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);