repository リソース 1.0

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Bitbucket Cloud v1 APIs are deprecated

Bitbucket Cloud REST API version 1 is deprecated effective 30 June 2018. All 1.0 APIs will be removed from the REST API permanently on 31 December 2018. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

概要

repository リソースでは、特定のリポジトリを指定する repo_slug を指定します。たとえば、リポジトリ https://bitbucket.org/tortoisehg/thgrepo_slugthg です。このリソースを使用して、新しいリポジトリを作成したり、既存のリポジトリを編集したりすることができます。ブランチ リソースに対してクエリを発行するための複数の URL があります。このリソースに対する未認証の呼び出しは、公開リポジトリの値のみを返します。

非公開リポジトリを表示するには、リポジトリで少なくとも読み取り権限を持っている必要があります。

新しいリポジトリの作成 廃止予定

認証しているユーザーのアカウントの配下に新しいリポジトリを作成します。アカウントが自動的にリポジトリのオーナーになります。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
name はい リポジトリの名前。
description いいえ リポジトリの説明。
scm いいえ git または hg の値。パラメータを指定しない場合、既定値は git です。
language いいえ リポジトリのソース コードで使用されている言語。 
is_private いいえ リポジトリが非公開 (true) か公開 (false) かを示すブール値。既定は false です。
https://api.bitbucket.org/1.0/repositories --data "name=mynewrepo"
Click to view the data returned on success...
{
    "scm": "git",
    "has_wiki": false,
    "last_updated": "2012-10-09 22:34:47",
    "creator": null,
    "forks_count": 0,
    "created_on": "2012-10-09 22:34:47",
    "owner": "tutorials",
    "logo": null,
    "email_mailinglist": "",
    "is_mq": false,
    "size": 0,
    "read_only": false,
    "fork_of": null,
    "mq_of": null,
    "followers_count": 1,
    "state": "creating",
    "utc_created_on": "2012-10-09 20:34:47+00:00",
    "website": "",
    "description": "",
    "has_issues": false,
    "is_fork": false,
    "slug": "test5003",
    "is_private": true,
    "name": "mynewrepo",
    "language": "",
    "utc_last_updated": "2012-10-09 20:34:47+00:00",
    "email_writers": true,
    "no_public_forks": false,
    "resource_uri": "/1.0/repositories/tutorials/test5003"
}

新しいフォークの追加

認証しているユーザーのアカウントの配下で新しくリポジトリをフォークします。アカウントが自動的にリポジトリのオーナーになります。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
name はい リポジトリの名前。
description いいえ リポジトリの説明。
scm Ignored この値を指定できますが、システムによって無視されます。
language いいえ リポジトリのソース コードで使用されている言語。 
is_private いいえ リポジトリが非公開 (true) か公開 (false) かを示すブール値。既定は false です。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/fork --data "name=mynewrepo"
Click to view the data returned on success...
{
  "scm": "hg",
  "has_wiki": false,
  "last_updated": "2013-01-29 19:36:47",
  "creator": null,
  "created_on": "2013-01-29 19:36:47",
  "owner": "auserbb",
  "logo": "https://d3oaxc4q5k2d6q.cloudfront.net/m/f2d828db6961/img/language-avatars/html5_16.png",
"email_mailinglist": "",
  "is_mq": false,
  "size": 0,
  "read_only": false,
  "fork_of": {
    "scm": "hg",
    "has_wiki": true,
    "last_updated": "2013-01-29 18:44:43",
    "creator": null,
    "created_on": "2011-12-20 17:35:06",
    "owner": "tutorials",
    "logo": "https://bitbucket-assetroot.s3.amazonaws.com/c/photos/2012/Nov/28/tutorials.bitbucket.org-logo-1456883302-9_avatar.png",
"email_mailinglist": "\ndocs@bitbucket.org",
    "is_mq": false,
    "size": 33473378,
    "read_only": false,
    "fork_of": null,
    "mq_of": null,
    "followers_count": 4,
    "state": "available",
    "utc_created_on": "2011-12-20 16:35:06+00:00",
    "website": "",
    "description": "Site for tutorial101 files",
    "has_issues": true,
    "is_fork": false,
    "slug": "tutorials.bitbucket.org",
"is_private": false,
    "name": "tutorials.bitbucket.org",
"language": "html/css",
    "utc_last_updated": "2013-01-29 17:44:43+00:00",
    "email_writers": true,
    "no_public_forks": false,
    "resource_uri": "/1.0/repositories/tutorials/tutorials.bitbucket.org"
},
  "mq_of": null,
  "followers_count": 0,
  "state": "creating",
  "utc_created_on": "2013-01-29 18:36:47+00:00",
  "website": null,
  "description": "this is a a long description",
  "has_issues": false,
  "is_fork": true,
  "slug": "tryitagainagain",
  "is_private": true,
  "name": "tryitagainagain",
  "language": "html/css",
  "utc_last_updated": "2013-01-29 18:36:47+00:00",
  "email_writers": true,

リポジトリの更新

既存のリポジトリを更新します。呼び出し元は、アカウントの管理権限を持つユーザーとして認証する必要があります。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい リポジトリ オーナーの accountname
repo_slug はい リポジトリのスラッグ。
name いいえ ユーザーに表示されるリポジトリ名。
description いいえ リポジトリの説明。
language いいえ リポジトリのソース コードで使用されている言語。 
is_private いいえ リポジトリが非公開 (true) か公開 (false) かを示すブール値。既定は true です。
landing_page いいえ ユーザーがリポジトリの URL にアクセスした場合に表示する既定ページ。
website いいえ リポジトリに関連する Web サイト。例として、企業の Web サイトがあります。
main_branch いいえ リポジトリのメイン ブランチ。
analytics_key いいえ トラッキング用の Google Analytics キー。これは Google から取得します。
akismet_key いいえ 課題トラッカーでのスパムを軽減するための Akismet キー。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}--data "description=long description"
ここをクリックして展開...
{
  "scm": "git",
  "has_wiki": false,
  "last_updated": "2013-10-10T02:06:48.181",
"no_forks": false,
  "forks_count": 0,
  "created_on": "2013-08-22T01:37:50.135",
"owner": "tutorials",
  "logo": "https://d3oaxc4q5k2d6q.cloudfront.net/m/95a419471117/img/language-avatars/default_16.png",
"email_mailinglist": "",
  "is_mq": false,
  "size": 19054,
  "read_only": false,
  "fork_of": null,
  "mq_of": null,
  "state": "available",
  "utc_created_on": "2013-08-21 23:37:50+00:00",
  "website": "",
  "description": "A sample code project",
  "has_issues": false,
  "is_fork": false,
  "slug": "samplecode",
  "is_private": false,
  "name": "samplecode",
  "language": "",
  "utc_last_updated": "2013-10-10 00:06:48+00:00",
  "email_writers": true,
  "no_public_forks": false,
  "creator": null,
  "resource_uri": "/1.0/repositories/tutorials/samplecode"

既存のリポジトリの削除 廃止予定

リポジトリを削除します。呼び出し元はリポジトリのオーナーとして認証している必要があります。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい リポジトリ オーナー。
repo_slug はい A repository belonging to the account.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}

成功すると、HTTP/1.1 204 NO CONTENT が返されます。

ブランチの一覧の取得

リポジトリに関連付けられたブランチの一覧を取得します。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/branches
Click to view the data returned on success...
{
    "master": {
        "node": "0b64d6000dad",
        "files": [
            {
                "type": "modified",
                "file": "atlassian-docco-cli/pom.xml"
},
            {
                "type": "modified",
                "file": "atlassian-docco-maven/pom.xml"
},
            {
                "type": "modified",
                "file": "atlassian-docco/pom.xml"
            },
            {
                "type": "modified",
                "file": "pom.xml"
}
        ],
        "raw_author": "Jonathan Doklovic <doklovic@atlassian.com>",
        "utctimestamp": "2012-05-07 22:35:02+00:00",
        "author": "doklovic_atlassian",
        "timestamp": "2012-05-08 00:35:02",
        "raw_node": "0b64d6000dad15bb8cc520d4cc6da7a6bf2c5b99",
        "parents": [
            "94aff5071793"
        ],
        "branch": "master",
        "message": "[maven-release-plugin] prepare for next development iteration\n",
        "revision": null,
        "size": -1
    }
}

リポジトリのメイン ブランチの取得

リポジトリに関連付けられたメイン ブランチを取得します。リポジトリのメイン ブランチは、リポジトリの [リポジトリ詳細] ページで設定します。

このメソッドは次のパラメーターをサポートしています。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/main-branch
Click to view the data returned on success...

メイン ブランチが設定されている場合、ブランチ名が返されます。

{
    "name": "master"
}

メイン ブランチが設定されていない場合、次の情報が返されます。

No main branch set.

ブランチのタグの一覧の取得

リポジトリのブランチと関連付けられたタグの一覧を取得します。

このメソッドは次のパラメーターをサポートしています。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/branches-tags
Click to view the data returned on success...
{
    "branches": [{
        "changeset": "a2e42cc621de6f596687389b8a9bed7f476b1007",
        "heads": ["a2e42cc621de6f596687389b8a9bed7f476b1007"],
        "name": "bb101repo-branch",
        "mainbranch": false
    }, {
        "changeset": "9ccfbab51780e0ca31e2738e1b91f5efa0bb46d0",
        "heads": ["9ccfbab51780e0ca31e2738e1b91f5efa0bb46d0"],
        "name": "master",
        "mainbranch": true
    }],
    "tags": [{
        "changeset": "a2e42cc621de6f596687389b8a9bed7f476b1007",
        "name": "bb101repo-branch"
    }]
}

リポジトリのマニフェストの取得

リビジョン用にリポジトリのマニフェストを取得します。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
revision はい defaultmaster などの、取得するリビジョン。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/{revision}
Click to view the data returned on success...
{
    "Readme": "cfed61d1bfe1",
    "index.html":"2151785dae36"
}

タグの一覧の取得

このリソースを使用すると、指定したリポジトリのタグとブランチの一覧を取得できます。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/tags
Click to view the data returned on success...
{
    "tip": {
        "node": "562344e0ae10",
        "files": [
            {
                "type": "modified",
                "file": "index.html"
}
        ],
        "raw_author": "Stephen Imhoff <clockwork-muse@hotmail.com>",
        "utctimestamp": "2012-08-12 02:06:43+00:00",
        "author": "clockwork_muse",
        "timestamp": "2012-08-12 04:06:43",
        "raw_node": "562344e0ae1016dee08679d84d687a8a6615d230",
        "parents": [
            "101f16a95c13"
        ],
        "branch": "default",
        "message": "Add tutorial quote.",
"revision": 1185,
        "size": -1
    }
}

元のソースの取得

このリソースを使用すると、ファイルまたはディレクトリの元のコンテンツまたはファイルを取得できます。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
revision  Yes 一覧を作成するリビジョンまたはブランチを指定する値。
path はい  パスには、ファイル名またはディレクトリ パスを指定できます。path/ で終わる場合、それはディレクトリとして扱われ、一覧が返されます。

次の呼び出しはディレクトリのコンテンツを取得します。

-v https://api.bitbucket.org/1.0/repositories/tutorials/tutorials.bitbucket.org/raw/default/images

default リビジョンのトップにある images ディレクトリのコンテンツを返します。この呼び出しは index.html ファイルのコンテンツを表示します。

-v https://api.bitbucket.org/1.0/repositories/tutorials/tutorials.bitbucket.org/raw/default/index.html

path では大文字と小文字が区別されるため、index.htmlIndex.html ファイルは異なります。非公開リポジトリの場合、呼び出し元がリポジトリへのアクセス権を持つユーザーとして認証する必要があります。

https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/raw/{revision}/{path}

呼び出しに成功すると、HTTP/1.1 200 OK が返されます。

ファイルの履歴をチェンジセットで取得

指定したチェンジセット以降のファイルの履歴を返します。このメソッドでは次のパラメータを使用できます。

パラメーター 必須かどうか 説明
accountname はい The team or individual account.
repo_slug はい A repository belonging to the account.
node はい チェンジセットのノード ID。
path はい ファイル名。
https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/filehistory/{node}/{path}
Click to view the data returned on success...
  {
    "node": "1b8a451e04ec",
    "files": [
      {
        "type": "added",
        "file": "onlyhere.txt"
}
    ],
    "raw_author": "Mary Anthony <manthony@atlassian.com>",
    "utctimestamp": "2012-11-11T05:27:13+00:00",
    "author": {
      "username": "restbrowser",
      "first_name": "Mary",
      "last_name": "Anthony",
      "is_team": false,
      "avatar": "https://secure.gravatar.com/avatar/e4ddd9b26ff93faf679d5b1aba114a04?d=https%3A%2F%2Fdwz7u9t8u8usb.cloudfront.net%2Fm%2F86a3f7769fd5%2Fimg%2Fdefault_avatar%2F32%2Fuser_blue.png&s=32",
"resource_uri": "/1.0/users/restbrowser"
},
    "timestamp": "2012-11-11 06:27:13",
    "raw_node": "1b8a451e04ec8e313da63d57327e88ca314d5aaf",
    "parents": [
      "34a84046efa8"
    ],
    "branch": "feature",
    "message": "adding only to this branch\n",
    "revision": null,
    "size": -1
  }
]
最終更新日 2018 年 6 月 14 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.