Platform api reference - herokaijp/devcenter GitHub Wiki

プラットフォヌムAPIはベヌタ版の機胜です。䞀般的に利甚可胜になる前には機胜が倉曎される事がありたす。
## 抂芁 プラットフォヌムAPIは開発者に自動化ず、拡匵、そしお他のサヌビスずの統合をする力を䞎えたす。このプラットフォヌムAPIを䜿っおプログラムからアプリを䜜成したり、アドオンを远加したり、以前たではダッシュボヌドやHerokuツヌルベルトにのみ関連づいおいた他のタスクを実行したりするこずができたす。始めるための詳现に぀いおは[quickstart](https://devcenter.heroku.com/articles/platform-api-quickstart)を確認しおください。 ### 認蚌 HTTPベヌシック認蚌はメヌルアドレスず[APIトヌクン](https://devcenter.heroku.com/articles/authentication)を`{email-address}:{api-token}`ずいう圢で組み合わせ、base64で゚ンコヌドし、それぞれのリク゚ストの認蚌ヘッダに枡される必芁がありたす。䟋えば `Authorization: Basic 0123456789ABCDEF=`ずいう圢になりたす。 APIトヌクン認蚌は個人レベルのスクリプトではよく動きたすが、サヌドパヌティのサヌビスではオススメしたせん。私たちは、サヌドパヌティ補のサヌビスぞのアクセスを提䟛する際により粟床が高く、操䜜性の良いものを提䟛するためベヌタでOAuthを䜿えるようにするこずを蚈画しおいたす。 ### キャッシュ 党おのレスポンスは`ETag`(もしくぱンティティタグ)ヘッダを含んでおり、返されたリ゜ヌスの指定されたバヌゞョンを特定しおいたす。この倀は、繰り返しリク゚ストを投げお、`If-None-Match`ヘッダ内の`ETag`の倀を枡す事で、リ゜ヌスの倉曎がないかを確認するのに䜿う事が出来るでしょう。もしリ゜ヌスに倉曎がなければ、空のボディず共に`304 Not Modified`ステヌタスが返されたす。もしリ゜ヌスに倉曎が合った堎合は、リク゚ストは普通に凊理されたす。 ### クラむアント クラむアントは必ずHTTPSを䜿っお`api.heroku.com`ぞリク゚ストを発行する必芁があり、`Accept: application/vnd.heroku+json; version=3`ずいうアクセプトヘッダを指定する必芁がありたす。クラむアントはトラッキングやデバッグがしやすいように、`User-Agent`ヘッダを指定しおおくべきでしょう。 ### cURL サンプル 実隓しやすいようにcURLのサンプルが提䟛されおいたす。倉数は、環境倉数を䜿っお眮き換えられるように、`$SOMETHING`ずしお存圚しおいたす。サンプルは、`~/.netrc`ファむルから認蚌情報を取埗するために、`-n`オプションを䜿甚したす。`.netrc`ファむルは以䞋ず䌌たようなものを`api.heroku.com`の為に含めおいるべきでしょう。 
machine api.heroku.com
  login {your-email}
  password {your-api-token}

カスタムタむプ

名前 JSONタむプ 説明
datetime string iso8601フォヌマットのタむムスタンプです。
uuid string UUIDは 8-4-4-4-12 のフォヌマットです。
### デヌタの完党性 ナニヌクIDずより人間に取っお芪和性の高い属性の䞡方は、リ゜ヌスを参照するのに぀かわれたす。たずえば、`name`や`id`をアプリケヌションを参照するのに䜿うでしょう。芪和性の高い語圙のほうが䟿利かもしれたせんが、`id`の方が曖昧さをさけるためにも良いでしょう。

あなたが最埌にレスポンスを受信しおから、リ゜ヌスに倉化がないかどうかを確かめるためにに、前のレスポンスから埗たEtagの倀ずずもにIf-Matchヘッダを枡すでしょう。もしリ゜ヌスに倉曎が合った堎合、412 Precondition Failedレスポンスを受け取るはずです。もしリ゜ヌスに倉曎がなければ、リク゚ストは正垞に凊理されたす。

゚ラヌ

倱敗しおいるレスポンスは、適切なstatusずJSONの内容を持ち合わせおいるはずです。

゚ラヌ属性

名前 タむプ 説明 䟋
id string 発生した゚ラヌのIDです。 "rate_limit"
message string 発生した゚ラヌの゚ンドナヌザ向けメッセヌゞです。 "Your account reached the API limit. Please wait a few minutes before making new requests"
### ゚ラヌのレスポンス ``` HTTP/1.1 429 Too Many Requests ``` ```javascript { "id": "rate_limit", "message": "Your account reached the API rate limit\nPlease wait a few minutes before making new requests" } ``` ### 叀いAPI 叀いものを䜿っおいるものは、[legacy-api-docs.heroku.com](https://legacy-api-docs.heroku.com)を参考に、v2 APIに倉えお行くべきです。 ### Methods
メ゜ッド 䜿い方
DELETE 存圚しおいるオブゞェクトを削陀するのに䜿われたす。
GET 個々のオブゞェクトのリストを取埗するのに䜿われたす。
HEAD あるオプゞェクずに関するメタデヌタを取埗するのに䜿われたす。
PATCH 存圚しおいるオブゞェクトずの曎新に䜿われたす。
PUT あるオブゞェクトを眮き換えるのに䜿われたす。
POST 新しいオブゞェクトを䜜成するのに䜿われたす。

メ゜ッドの䞊曞き

党おのメ゜ッドをサポヌトしおいないクラむアントを䜿甚しおいる堎合、POSTず、X-Http-Method-Overrideヘッダを䜿う事で、䜿いたいメ゜ッドぞ䞊曞きする事ができたす。䟋えば、PATCHリク゚ストを行うために、X-Http-Method-Override: PATCHヘッダず共にPOSTを実行したす。

パラメヌタ

あるアクションに察しお提䟛され埗る倀は、必須の倀ずオプションずに分けられたす。予想されるタむプの倀は指定されおおり、その䞭にない倀が枡されいおも倉化しないようになっおいるべきです。パラメヌタはJSON圢匏になっおいお、リク゚ストボディに枡されるべきです。

レンゞ

リストを芁求するリク゚ストは、返っお来た倀のレンゞを瀺すContent-Rangeヘッダを返したす。倧きなリストは、党お取埗するためには远加でリク゚ストが必芁になるでしょう。もしリストのレスポンスが刈り蟌たれおいた堎合、206 Partial Contentステヌタず、次のレンゞを瀺すNext-Rangeヘッダずその倀を受け取りたす。次のレンゞを受け取る堎合は、Rangeヘッダに前のリク゚ストのNext-Rangeヘッダの内容を蚭定しながらリク゚ストを再床送りたす。

RangeAPIの䞀般的なフォヌマットは <attribute> [<start>]..[<end>][; param1=value1, ...]の様な圢をしおいるでしょう。曎に、<start>の倀は、幅の開始が定矩されおいないこずを瀺すために、閉じ倧括匧(])を接頭蟞ずしお䜿う事があり、同様に幅の終了が定矩されおいない事を瀺すために、開始倧括匧([)を<end>の倀の接尟蟞ずしお䜿う事がありたす。

レンゞ内で返される倀の数は、Rangeヘッダのパラメヌタリスト内のmaxキヌを䜿う事でコントロヌルが可胜です。䟋えば、始めの個だけの倀を取埗する堎合、このヘッダにRange: id ..; max=10;ず蚭定したす。maxはNext-Rangeを䜿っおむテレヌションしおいる堎合でも枡す事が出来たす。デフォルトのペヌゞサむズは200で最倧サむズは1000です。

結果の䞊び順もRangeヘッダでコントロヌルができたす。どんなリストの゚ンドポむントもどの属性で結果の䞊び替えが出来るかを瀺すAccept-Rangesヘッダを返答したす。これらのレンゞの䞀぀から、Rangeを䜿ったリク゚ストを䜜成しお䜿う事ができたす。䟋えばGET /appsはAccept-Ranges: id, nameずレスポンスを返したす。nameで゜ヌトを掛けるリク゚ストをする堎合、゚ンドポむントに察するリク゚ストにRange: name ..ヘッダを付䞎したす。䞊び替えのデフォルトは昇順ですが、orderパラメヌタで倉曎可胜です。䟋えば、 Range: name ..; order=descがありたす。

リミット

このAPIは、䞍正䜿甚やバグから守るために、それぞれのナヌザが䞀時間圓たりに投げられるリク゚ストの数を制限しおいたす。それぞれのアカりントは1200トヌクンを保持できるリク゚ストトヌクンのプヌルを持っおいたす。それぞれのAPIコヌルでプヌルからトヌクンが取り陀かれたす。トヌクンはアカりントにひもづくプヌルに時間に1200の割合で远加されお行き、最倧は1200です。トヌクンが党くなくなっおしたった堎合、それ以降の呌び出しは、トヌクンが䜿えるようになるたで429Too Many Requestsを返したす。

珟圚のトヌクンの数を確認するために、RateLimit-Remainingレスポンスヘッダを䜿う事ができたす。たた、トヌクン数取埗のため、rate limit゚ンドポむントに察しお問い合わせする事も出来たす。rate limit ゚ンドポむントに察するリク゚ストは制限の察象ずしおカりントされたせん。もしあなたのアカりントが制限数に達したが、原因がよく分からない堎合、Herokuダッシュボヌド䞊のアカりントペヌゞでAPIキヌが埪環しおいないか怜蚎しおみおください。

リク゚スト ID

それぞれのAPIのレスポンスはトラッキングがしやすいように、Request-Idヘッダ内ナニヌクなリク゚ストIDを含んでいたす。問題を報告する際に、この倀を呈瀺しおもらう事は、より玠早く問題を特定し解決策を提䟛するこずを容易にしたす。

レスポンス

APIによっお返华される倀は、ステヌタスコヌドの䟋ず関係するヘッダ䞀般的なHTTPのヘッダが省略された状態で、そしお(もしあれば)JSONボディの䟋に分けられたす。

レスポンスヘッダ

ヘッダ 説明
RateLimit-Remaining この期間に蚱可されおいるリク゚ストの数です
### ステヌタス
コヌド 発生元 Id メッセヌゞ
200 äž¡æ–¹ OK リク゚ストが成功したした。
201 äž¡æ–¹ Created リ゜ヌスが䜜成されたした。䟋えば、新しいアプリケヌションが䜜られたり、アドオンが远加された堎合です。
202 äž¡æ–¹ Accepted リク゚ストが受理されたしたが、凊理は完了しおいたせん。
206 äž¡æ–¹ Partial Content リク゚ストは成功したしたが、これは郚分的なレスポンスです。レンゞを確認しおください。
400 クラむアント Bad Request リク゚ストは無効です。䜿甚方法を確認しお、再床実行しおください。
401 クラむアント Unauthorized リク゚ストは認蚌されたせんでした。認蚌情報を確認しお、再床実行しおください。
402 クラむアント Payment Required リク゚ストに関する支払いが完了しおいたせん。決枈情報を確認した䞊で、再床実行しおください。
403 クラむアント Forbidden リク゚ストには暩限が付䞎されおいたせん。提䟛された認蚌情報では、指定されたリ゜ヌスぞのアクセスが出来たせん。
404 クラむアント Not Found リク゚ストが倱敗したした。指定されたリク゚ストは存圚しおいたせん。
406 クラむアント Not Acceptable リク゚ストが倱敗したした。Accept: application/vnd.heroku+json; version=3 ヘッダを付䞎しお、再床実行をしおください。
416 クラむアント Requested Range Not Satisfiable リク゚ストが倱敗したした。Content-Rangeヘッダを確認しお、再床実行しおください。
422 クラむアント Unprocessable Entity リク゚ストが倱敗したした。パラメヌタを確認しお、再床実行しおください。
429 クラむアント Too Many Requests リク゚ストがが倱敗したした。リク゚スト数の䞊限がリセットされるのを埅っお、再床実行しおください。リミットを確認しおください。
500 Heroku Internal Server Error ゚ラヌが発生したした。私たちは問題に぀いお認識はしおいたすが、問題が続く堎合はサポヌトぞ連絡をください。
503 Heroku Service Unavailable APIは䜿甚䞍可胜です。さらなる詳现は、レスポンスボディを確認するか、Heroku statusを確認しおください。
### バヌゞョン APIのベヌタ版やリリヌス版はversion3で起こりたす。私たちはベヌタ版の間に䜜るだろう、バックの非互換性の倉曎に぀いおの譊告や移行の方法を提䟛し、version3のリリヌス版が出たあずはバックの非互換な倉曎をコミットしない予定です。 ### è­Šå‘Š 譊告を䌎うレスポンスは、譊告に぀いお説明しおいるヘッダを付䞎しおいたす。 ### Warning Headers
ヘッダ 説明 䟋
id 譊告のID "stack_deprecated"
message ゚ンドナヌザ向けの譊告のメッセヌゞ "This stack is deprecated."
## アカりント アカりントはHerokuでのあなたの代わりです。 ### 属性
名前 タむプ 説明 䟋
allow_tracking boolean Google Analyticsの様なサヌドパヌティのサヌビスにWebのアクティビティのトラッキングを蚱可させるかどうか true
beta boolean Herokuのベヌタ機胜を利甚するかどうか false
created_at datetime アカりントが䜜られた日時 2012-01-01T12:00:00Z
email string アカりントのメヌルアドレス "[email protected]"
id uuid アカりントのナニヌクID 01234567-89ab-cdef-0123-456789abcdef
last_login datetime Herokuから最埌に暩限付䞎された日時 2012-01-01T12:00:00Z
updated_at datetime アカりントの曎新日時 2012-01-01T12:00:00Z
verified boolean アカりントが決枈情報によっお認蚌されたかどうか false
### アカりントの情報 ``` GET /account ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "allow_tracking": true, "beta": false, "created_at": "2012-01-01T12:00:00Z", "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef", "last_login": "2012-01-01T12:00:00Z", "updated_at": "2012-01-01T12:00:00Z", "verified": false } ``` ### アカりントの曎新 ``` PATCH /account ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
allow_tracking boolean Google Analyticsの様なサヌドパヌティのサヌビスにWebのアクティビティのトラッキングを蚱可させるかどうか true
email string アカりントのメヌルアドレス "[email protected]"
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/account \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"allow_tracking\":true,\"email\":\"[email protected]\"}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "allow_tracking": true, "beta": false, "created_at": "2012-01-01T12:00:00Z", "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef", "last_login": "2012-01-01T12:00:00Z", "updated_at": "2012-01-01T12:00:00Z", "verified": false } ``` ## アカりントの機胜 アカりントの機胜ずは、Herokuのアカりントにずっお利甚可胜かどうかずいうHerokuラボの利甚可胜性を衚しおいたす。

属性

名前 タむプ 説明 䟋
created_at datetime アカりントの機胜が䜜られた日時 2012-01-01T12:00:00-00:00
description string アカりントの機胜の説明 "Causes account to example."
doc_url string アカりントの機胜のドキュメントのURL "http://devcenter.heroku.com/articles/example"
enabled boolean アカりントの機胜が有効化されたかどうか true
id uuid アカりントの機胜のナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string アカりントの機胜のナニヌクな名前 "example"
updated_at datetime アカりントの機胜が曎新された日時 2012-01-01T12:00:00-00:00
### アカりントの機胜のリスト ``` GET /account/features ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/features \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00-00:00", "description": "Causes account to example.", "doc_url": "http://devcenter.heroku.com/articles/example", "enabled": true, "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "updated_at": "2012-01-01T12:00:00-00:00" } ] ``` ### アカりントの機胜の情報 ``` GET /account/features/{feature_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/features/$FEATURE_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00-00:00", "description": "Causes account to example.", "doc_url": "http://devcenter.heroku.com/articles/example", "enabled": true, "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ### アカりントの機胜 の曎新 ``` PATCH /account/features/{feature_id_or_name} ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
enabled boolean アカりントの機胜が有効化されおいるかどうか true
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/account/features/$FEATURE_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"enabled\":true}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00-00:00", "description": "Causes account to example.", "doc_url": "http://devcenter.heroku.com/articles/example", "enabled": true, "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ## アカりントのパスワヌド

属性

名前 タむプ 説明 䟋
current_password string 既存のパスワヌドの倀 "0123456789abcdef"
password string 新しいパスワヌドの倀 "abcdef0123456789"
### Account Passwordの曎新 ``` PUT /account/password ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
current_password string 既存のパスワヌドの倀 "0123456789abcdef"
password string 新しいパスワヌドの倀 "abcdef0123456789"
#### Curlの䟋 ```term $ curl -n -X PUT https://api.heroku.com/account/password \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"current_password\":\"0123456789abcdef\",\"password\":\"abcdef0123456789\"}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { } ``` ## アドオン アドオンはアプリケヌションに配備されおいるアドオンを衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
config object 远加で指定されおいるアドオンの蚭定 {}
created_at datetime アドオンがが䜜成された日時 2012-01-01T12:00:00Z
id uuid このアドオンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
plan:id uuid プランに察するナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
plan:name string プランに察するナニヌクな名前 "heroku-postgresql:dev"
updated_at datetime アドオンの曎新日時 2012-01-01T12:00:00Z
### アドオンの䜜成 ``` POST /apps/{app_id_or_name}/addons ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
config object 远加で指定されおいるアドオンの蚭定 {}
plan:id uuid プランに察するナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
plan:name string プランに察するナニヌクな名前 "heroku-postgresql:dev"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/addons \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"config\":{},\"plan\":{\"id\":\"01234567-89ab-cdef-0123-456789abcdef\",\"name\":\"heroku-postgresql:dev\"}}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "plan": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev" }, "updated_at": "2012-01-01T12:00:00Z" } ``` ### アドオンのリスト ``` GET /apps/{app_id_or_name}/addons ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/addons \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "plan": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev" }, "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### アドオンの情報 ``` GET /apps/{app_id_or_name}/addons/{addon_id} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/addons/$ADDON_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "plan": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev" }, "updated_at": "2012-01-01T12:00:00Z" } ``` ### アドオンの曎新 ``` PATCH /apps/{app_id_or_name}/addons/{addon_id} ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
config object 远加で指定されおいるアドオンの蚭定 {}
plan:id uuid プランに察するナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
plan:name string プランに察するナニヌクな名前 "heroku-postgresql:dev"
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/addons/$ADDON_ID \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"config\":{},\"plan\":{\"id\":\"01234567-89ab-cdef-0123-456789abcdef\",\"name\":\"heroku-postgresql:dev\"}}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "plan": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev" }, "updated_at": "2012-01-01T12:00:00Z" } ``` ### アドオンの削陀 ``` DELETE /apps/{app_id_or_name}/addons/{addon_id} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/apps/$APP_ID_OR_NAME/addons/$ADDON_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "plan": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev" }, "updated_at": "2012-01-01T12:00:00Z" } ``` ## アドオンサヌビス アドオンサヌビスはアプリケヌションに配備されおいるだろうアドオンを衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime アドオンサヌビスが䜜成された日時 2012-01-01T12:00:00Z
id uuid サヌビスのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string サヌビスのナニヌクな名前 "heroku-postgresql"
updated_at datetime アドオンサヌビスが曎新された日時 2012-01-01T12:00:00Z
### アドオンサヌビスの䞀芧 ``` GET /addon-services ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/addon-services \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### アドオンサヌビスの情報 ``` GET /addon-services/{addon_service_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/addon-services/$ADDON_SERVICE_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql", "updated_at": "2012-01-01T12:00:00Z" } ``` ## アプリケヌション アプリケヌションはHeroku䞊でデプロむし、実行したいプログラムを衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
archived_at datetime アプリケヌションがアヌカむブされた日時 2012-01-01T12:00:00Z
buildpack_provided_description string アプリケヌションのビルドパックからの説明 "Ruby/Rack"
created_at datetime アプリケヌションが䜜成された日時 2012-01-01T12:00:00Z
git_url string アプリケヌションのGitリポゞトリのURL "[email protected]/example.git"
id uuid アプリケヌションのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
maintenance boolean アプリケヌションのメンテナンスステヌタス false
name string アプリケヌションのナニヌクな名前 "example"
owner:email string アプリケヌションの所有者のメヌルアドレス "[email protected]"
owner:id uuid アプリケヌションの所有者のナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
region:id uuid アプリケヌションのリヌゞョンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
region:name string アプリケヌションのリヌゞョンの名前 "us"
released_at datetime アプリケヌションが最埌にリリヌスされた日時 2012-01-01T12:00:00Z
repo_size number アプリケヌションのGitリポゞトリのサむズバむト 1024
slug_size number アプリケヌションのスラッグの倧きさバむト 512
stack string アプリケヌションのスタック "cedar"
updated_at datetime アプリケヌションの曎新日時 2012-01-01T12:00:00Z
web_url string アプリケヌションのWebのURL "http://example.herokuapp.com"
### アプリケヌションの䜜成 ``` POST /apps ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
name string アプリケヌションのナニヌクな名前 "example"
region:id uuid アプリケヌションのリヌゞョンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
region:name string アプリケヌションのリヌゞョンの名前 "us"
stack string アプリケヌションのスタック "cedar"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"name\":\"example\",\"region\":{\"id\":\"01234567-89ab-cdef-0123-456789abcdef\",\"name\":\"us\"},\"stack\":\"cedar\"}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "archived_at": "2012-01-01T12:00:00Z", "buildpack_provided_description": "Ruby/Rack", "created_at": "2012-01-01T12:00:00Z", "git_url": "[email protected]/example.git", "id": "01234567-89ab-cdef-0123-456789abcdef", "maintenance": false, "name": "example", "owner": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "region": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us" }, "released_at": "2012-01-01T12:00:00Z", "repo_size": 1024, "slug_size": 512, "stack": "cedar", "updated_at": "2012-01-01T12:00:00Z", "web_url": "http://example.herokuapp.com" } ``` ### アプリケヌションの䞀芧 ``` GET /apps ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "archived_at": "2012-01-01T12:00:00Z", "buildpack_provided_description": "Ruby/Rack", "created_at": "2012-01-01T12:00:00Z", "git_url": "[email protected]/example.git", "id": "01234567-89ab-cdef-0123-456789abcdef", "maintenance": false, "name": "example", "owner": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "region": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us" }, "released_at": "2012-01-01T12:00:00Z", "repo_size": 1024, "slug_size": 512, "stack": "cedar", "updated_at": "2012-01-01T12:00:00Z", "web_url": "http://example.herokuapp.com" } ] ``` ### アプリケヌションの情報 ``` GET /apps/{app_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "archived_at": "2012-01-01T12:00:00Z", "buildpack_provided_description": "Ruby/Rack", "created_at": "2012-01-01T12:00:00Z", "git_url": "[email protected]/example.git", "id": "01234567-89ab-cdef-0123-456789abcdef", "maintenance": false, "name": "example", "owner": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "region": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us" }, "released_at": "2012-01-01T12:00:00Z", "repo_size": 1024, "slug_size": 512, "stack": "cedar", "updated_at": "2012-01-01T12:00:00Z", "web_url": "http://example.herokuapp.com" } ``` ### アプリケヌションの曎新 ``` PATCH /apps/{app_id_or_name} ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
maintenance boolean maintenance status of app false
name string unique name of app "example"
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"maintenance\":false,\"name\":\"example\"}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "archived_at": "2012-01-01T12:00:00Z", "buildpack_provided_description": "Ruby/Rack", "created_at": "2012-01-01T12:00:00Z", "git_url": "[email protected]/example.git", "id": "01234567-89ab-cdef-0123-456789abcdef", "maintenance": false, "name": "example", "owner": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "region": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us" }, "released_at": "2012-01-01T12:00:00Z", "repo_size": 1024, "slug_size": 512, "stack": "cedar", "updated_at": "2012-01-01T12:00:00Z", "web_url": "http://example.herokuapp.com" } ``` ### アプリケヌションの削陀 ``` DELETE /apps/{app_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/apps/$APP_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "archived_at": "2012-01-01T12:00:00Z", "buildpack_provided_description": "Ruby/Rack", "created_at": "2012-01-01T12:00:00Z", "git_url": "[email protected]/example.git", "id": "01234567-89ab-cdef-0123-456789abcdef", "maintenance": false, "name": "example", "owner": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "region": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us" }, "released_at": "2012-01-01T12:00:00Z", "repo_size": 1024, "slug_size": 512, "stack": "cedar", "updated_at": "2012-01-01T12:00:00Z", "web_url": "http://example.herokuapp.com" } ``` ## アプリケヌションの機胜 アプリケヌションの機胜ずは、Herokuのアプリケヌションにずっお利甚可胜かどうかずいうHerokuラボの利甚可胜性を衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime アプリケヌションの機胜が䜜成された日時 2012-01-01T12:00:00-00:00
description string アプリケヌションの機胜の説明 "Causes app to example."
doc_url string アプリケヌションの機胜のドキュメントのURL "http://devcenter.heroku.com/articles/example"
enabled boolean アプリケヌションの機胜が利甚可胜かどうか true
id uuid アプリケヌションの機胜のナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string uアプリケヌションの機胜のナニヌクな名前 "example"
updated_at datetime アプリケヌションの機胜が曎新された日時 2012-01-01T12:00:00-00:00
### アプリケヌションの機胜の䞀芧 ``` GET /apps/{app_id_or_name}/features ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/features \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00-00:00", "description": "Causes app to example.", "doc_url": "http://devcenter.heroku.com/articles/example", "enabled": true, "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "updated_at": "2012-01-01T12:00:00-00:00" } ] ``` ### アプリケヌションの機胜の情報 ``` GET /apps/{app_id_or_name}/features/{feature_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/features/$FEATURE_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00-00:00", "description": "Causes app to example.", "doc_url": "http://devcenter.heroku.com/articles/example", "enabled": true, "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ### アプリケヌションの機胜の曎新 ``` PATCH /apps/{app_id_or_name}/features/{feature_id_or_name} ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
enabled boolean アプリケヌションの機胜が利甚可胜かどうか true
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/features/$FEATURE_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"enabled\":true}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00-00:00", "description": "Causes app to example.", "doc_url": "http://devcenter.heroku.com/articles/example", "enabled": true, "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ## アプリケヌショントランスファヌ [トランスファヌ](https://devcenter.heroku.com/articles/transferring-apps)はナヌザにアプリケヌションの所有暩を他のナヌザに移す事を蚱したす。移行されたアプリケヌションは無料か有料のリ゜ヌスを持っおいるず思いたすが、もし有料ならば、受け取ったナヌザは[アカりントの認蚌](https://devcenter.heroku.com/articles/account-verification)をする必芁がありたす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime トランスファヌが䜜成された日時 2012-01-01T12:00:00Z
app:id string 移行されたアプリケヌションのナニヌクなID "01234567-89ab-cdef-0123-456789abcdef"
app:name string 移行されたアプリケヌションの名前 "example"
id uuid このトランスファヌのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
owner:id string 送信したナヌザのナニヌクなID "01234567-89ab-cdef-0123-456789abcdef"
owner:email string 送信したナヌザのメヌルアドレス "[email protected]"
recipient:id string 受信するナヌザのナニヌクなID "01234567-89ab-cdef-0123-456789abcdef"
recipient:email string 受信するナヌザのメヌルアドレス "[email protected]"
state string トランスファヌの最新の状態; accepted/declined/pending "pending"
updated_at datetime トランスファヌが曎新された日時 2012-01-01T12:00:00Z
### アプリケヌショントランスファヌの䜜成 ``` POST /account/app-transfers ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
app:id string 移行されたアプリケヌションのナニヌクなID "01234567-89ab-cdef-0123-456789abcdef"
app:name string 移行されたアプリケヌションの名前 "example"
recipient:id string 受信するナヌザのナニヌクなID "01234567-89ab-cdef-0123-456789abcdef"
recipient:email string 受信するナヌザのメヌルアドレス "[email protected]"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/account/app-transfers \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"app\":{\"id\":\"01234567-89ab-cdef-0123-456789abcdef\",\"name\":\"example\"},\"recipient\":{\"email\":\"[email protected]\",\"id\":\"01234567-89ab-cdef-0123-456789abcdef\"}}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "app": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "owner": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "recipient": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "state": "pending", "updated_at": "2012-01-01T12:00:00Z" } ``` ### アプリケヌショントランスファヌの䞀芧 ``` GET /account/app-transfers ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/app-transfers \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "app": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "owner": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "recipient": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "state": "pending", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### アプリケヌショントランスファヌの情報 ``` GET /account/app-transfers/{transfer_id} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/app-transfers/$TRANSFER_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "app": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "owner": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "recipient": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "state": "pending", "updated_at": "2012-01-01T12:00:00Z" } ``` ### アプリケヌショントランスファヌの曎新 ``` PATCH /account/app-transfers/{transfer_id} ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
state string トランスファヌの最新の状態; accepted/declined/pending "pending"
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/account/app-transfers/$TRANSFER_ID \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"state\":\"pending\"}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "app": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "owner": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "recipient": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "state": "pending", "updated_at": "2012-01-01T12:00:00Z" } ``` ### アプリケヌショントランスファヌの削陀 ``` DELETE /account/app-transfers/{transfer_id} ``` #### Curlの䟋 ```term $ curl -n -X Delete https://api.heroku.com/account/app-transfers/$TRANSFER_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "app": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "owner": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "recipient": { "id": "01234567-89ab-cdef-0123-456789abcdef", "email": "[email protected]" }, "state": "pending", "updated_at": "2012-01-01T12:00:00Z" } ``` ## コラボレヌタ コラボレヌタはHerokuのアプリケヌションにアクセスできるようになった他のナヌザです。 ### 属性
名前 タむプ 説明 䟋
created_at datetime コラボレヌタが䜜成された日時 2012-01-01T12:00:00Z
id uuid このコラボレヌタのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
silent boolean trueの堎合、コラボレヌション甚の招埅をメヌルで送るのをやめたす false
updated_at datetime コラボレヌタが曎新された日時 2012-01-01T12:00:00Z
user:email string コラボレヌタのメヌルアドレス "[email protected]"
user:id uuid ナヌザのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
### コラボレヌタの䜜成 ``` POST /apps/{app_id_or_name}/collaborators ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
silent boolean trueの堎合、コラボレヌション甚の招埅をメヌルで送るのをやめたす false
user:email string コラボレヌタのメヌルアドレス "[email protected]"
user:id uuid ナヌザのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"silent\":false,\"user\":{\"email\":\"[email protected]\",\"id\":\"01234567-89ab-cdef-0123-456789abcdef\"}}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "user": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" } } ``` ### コラボレヌタの䞀芧 ``` GET /apps/{app_id_or_name}/collaborators ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "user": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" } } ] ``` ### コラボレヌタの情報 ``` GET /apps/{app_id_or_name}/collaborators/{collaborator_id_or_email} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators/$COLLABORATOR_ID_OR_EMAIL \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "user": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" } } ``` ### コラボレヌタの削陀 ``` DELETE /apps/{app_id_or_name}/collaborators/{collaborator_id_or_email} ``` #### Curlの䟋 ```term $ curl -n -X Delete https://api.heroku.com/apps/$APP_ID_OR_NAME/collaborators/$COLLABORATOR_ID_OR_EMAIL \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "user": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" } } ``` ## 蚭定倉数 蚭定倉数はHerokuのアプリケヌションぞ提䟛される蚭定情報の管理を蚱可したす。 ### 属性
名前 タむプ 説明 䟋
{key} string Dynoの環境甚のキヌバリュヌのペア "{value}"
### 蚭定倉数の情報 ``` GET /apps/{app_id_or_name}/config-vars ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/config-vars \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "FOO": "bar", "BAZ": "qux", "QUUX": "corge" } ``` ### 蚭定倉数の曎新 ``` PATCH /apps/{app_id_or_name}/config-vars ``` #### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/config-vars \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "BAZ": "grault", "QUUX": "corge" } ``` ## ドメむン ドメむンは、Herokuのアプリケヌションぞどのルヌタが接続されるべきかを定矩したす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime ドメむンが䜜成された日時 2012-01-01T12:00:00Z
hostname string 完党なホスト名 "subdomain.example.com"
id uuid このドメむンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
updated_at datetime ドメむンが曎新された日時 2012-01-01T12:00:00Z
### ドメむンの䜜成 ``` POST /apps/{app_id_or_name}/domains ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
hostname string 完党なホスト名 "subdomain.example.com"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/domains \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"hostname\":\"subdomain.example.com\"}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "hostname": "subdomain.example.com", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ``` ### ドメむンの䞀芧 ``` GET /apps/{app_id_or_name}/domains ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/domains \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "hostname": "subdomain.example.com", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### ドメむンの情報 ``` GET /apps/{app_id_or_name}/domains/{domain_id_or_hostname} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/domains/$DOMAIN_ID_OR_HOSTNAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "hostname": "subdomain.example.com", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ``` ### Domainの削陀 ``` DELETE /apps/{app_id_or_name}/domains/{domain_id_or_hostname} ``` #### Curlの䟋 ```term $ curl -n -X Delete https://api.heroku.com/apps/$APP_ID_OR_NAME/domains/$DOMAIN_ID_OR_HOSTNAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "hostname": "subdomain.example.com", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ``` ## Dyno DynoはHerokuのアプリケヌションの実行凊理をカプセル化したす。 ### 属性
名前 タむプ 説明 䟋
attach boolean 出力を流しおいるかどうか true
attach_url string 付属したプロセスから出力を流しおいるURLか、プロセスがひもづいおいない堎合はnullが入りたす "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}"
command string このプロセスを開始するために䜿われるコマンド "bash"
created_at datetime ドメむンが䜜成された日時 2012-01-01T12:00:00Z
env hash Dynoの実行のための远加の環境倉数 {"COLUMNS"=>80, "LINES"=>24}
id uuid このDynoのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string アプリ䞊でのこのプロセスの名前 "run.1"
release:id uuid このプロセスが開始されたリリヌスのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
release:version number このプロセスが開始されたリリヌスのナニヌクなバヌゞョン 456
size number Dynoのサむズ (デフォルトは1) 1
state string プロセスの珟圚のステヌタス(以䞋のどれか: crashed, down, idle, starting, up) "up"
type string プロセスのタむプ "run"
updated_at datetime プロセスが最埌に状態を倉えた日時 2012-01-01T12:00:00Z
### Dynoの䜜成 ``` POST /apps/{app_id_or_name}/dynos ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
command string このプロセスを開始するために䜿われるコマンド "bash"
#### オプションのパラメヌタ
名前 タむプ 説明 䟋
attach boolean 出力を流しおいるかどうか true
env hash Dynoの実行のための远加の環境倉数 {"COLUMNS"=>80, "LINES"=>24}
size number Dynoのサむズ (デフォルトは1) 1
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"attach\":true,\"env\":{\"COLUMNS\":80,\"LINES\":24},\"size\":1,\"command\":\"bash\"}" ``` #### レスポンス ``` HTTP/1.1 201 Created ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}", "command": "bash", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "run.1", "release": { "id": "01234567-89ab-cdef-0123-456789abcdef", "version": 456 }, "size": 1, "state": "up", "type": "run", "updated_at": "2012-01-01T12:00:00Z" } ``` ### Dynoの䞀芧 ``` GET /apps/{app_id_or_name}/dynos ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}", "command": "bash", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "run.1", "release": { "id": "01234567-89ab-cdef-0123-456789abcdef", "version": 456 }, "size": 1, "state": "up", "type": "run", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### Dynoの情報 ``` GET /apps/{app_id_or_name}/dynos/{dyno_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos/$DYNO_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}", "command": "bash", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "run.1", "release": { "id": "01234567-89ab-cdef-0123-456789abcdef", "version": 456 }, "size": 1, "state": "up", "type": "run", "updated_at": "2012-01-01T12:00:00Z" } ``` ### Dynoの削陀 ``` DELETE /apps/{app_id_or_name}/dynos/{dyno_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X Delete https://api.heroku.com/apps/$APP_ID_OR_NAME/dynos/$DYNO_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "attach_url": "rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}", "command": "bash", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "run.1", "release": { "id": "01234567-89ab-cdef-0123-456789abcdef", "version": 456 }, "size": 1, "state": "up", "type": "run", "updated_at": "2012-01-01T12:00:00Z" } ``` ## 構成 あなたのアプリケヌションのために維持されるべきプロセスの構成です。コマンドずタむプは、アプリケヌションず共にアップロヌドされたProcfileによっお定矩されたす。 ### 属性
名前 タむプ 説明 䟋
command string プロセスタむプの為に䜿うコマンド "bundle exec rails server -p $PORT"
created_at datetime プロセスタむプが䜜成された日時 2012-01-01T12:00:00Z
id uuid このプロセスタむプのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
quantity number 維持しおいるプロセスの数 1
size number Dynoの数 (デフォルトは1) 1
type string 維持しおいるプロセスのタむプ "web"
updated_at datetime Dynoのタむプが曎新された日時 2012-01-01T12:00:00Z
### 構成の䞀芧 ``` GET /apps/{app_id_or_name}/formation ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/formation \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "command": "bundle exec rails server -p $PORT", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "quantity": 1, "size": 1, "type": "web", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### 構成の情報 ``` GET /apps/{app_id_or_name}/formation/{formation_id_or_type} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/formation/$FORMATION_ID_OR_TYPE \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "command": "bundle exec rails server -p $PORT", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "quantity": 1, "size": 1, "type": "web", "updated_at": "2012-01-01T12:00:00Z" } ``` ### 構成の曎新 ``` PATCH /apps/{app_id_or_name}/formation/{formation_id_or_type} ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
quantity number number of processes to maintain 1
size number dyno size (default: 1) 1
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/formation/$FORMATION_ID_OR_TYPE \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"quantity\":1,\"size\":1}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "command": "bundle exec rails server -p $PORT", "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "quantity": 1, "size": 1, "type": "web", "updated_at": "2012-01-01T12:00:00Z" } ``` ## キヌ キヌはアカりントに関連づいおおり、Gitのオペレヌションが出来るようにナヌザに暩限付䞎するために䜿われる公開SSHキヌを衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime キヌが䜜成された日時 2012-01-01T12:00:00Z
email string キヌの内容で提䟛されおいるメヌルアドレス "[email protected]"
fingerprint string 内容を元にしおいるナニヌクな文字列 "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf"
id uuid このキヌのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
public_key string アップロヌドされた、完党なpublic_key "ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]"
updated_at datetime キヌが曎新された日時 2012-01-01T12:00:00Z
### キヌの䜜成 ``` POST /account/keys ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
public_key string アップロヌドされた、完党なpublic_key "ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/account/keys \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"public_key\":\"ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]\"}" ``` #### レスポンス ``` HTTP/1.1 201 Created ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "email": "[email protected]", "fingerprint": "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf", "id": "01234567-89ab-cdef-0123-456789abcdef", "public_key": "ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]", "updated_at": "2012-01-01T12:00:00Z" } ``` ### キヌの䞀芧 ``` GET /account/keys ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/keys \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "email": "[email protected]", "fingerprint": "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf", "id": "01234567-89ab-cdef-0123-456789abcdef", "public_key": "ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### キヌの情報 ``` GET /account/keys/{key_id_or_fingerprint} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/keys/$KEY_ID_OR_FINGERPRINT \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "email": "[email protected]", "fingerprint": "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf", "id": "01234567-89ab-cdef-0123-456789abcdef", "public_key": "ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]", "updated_at": "2012-01-01T12:00:00Z" } ``` ### キヌの削陀 ``` DELETE /account/keys/{key_id_or_fingerprint} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/account/keys/$KEY_ID_OR_FINGERPRINT \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "email": "[email protected]", "fingerprint": "17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf", "id": "01234567-89ab-cdef-0123-456789abcdef", "public_key": "ssh-rsa AAAAB3NzaC1ycVc/../839Uv [email protected]", "updated_at": "2012-01-01T12:00:00Z" } ``` ## ログドレむン [ログドレむン](https://devcenter.heroku.com/articles/logging#syslog-drains)はHerokuのログを倖郚的なシステムログサヌバぞ長期的にアヌカむブできるような方法を提䟛しおいたす。 この倖郚サヌビスはHerokuからシステムログのパケットを受け取るように蚭定されおいる必芁がありたす。さらに、そのURLはこのAPIヲ䜿っおアプリケヌションに远加するこずが可胜です。 ### 属性
名前 タむプ 説明 䟋
addon:id uuid ドレむンを提䟛するアドオンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
created_at datetime ログドレむンが䜜成された日時 2012-01-01T12:00:00Z
id uuid このログドレむンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
updated_at datetime ログセッションが曎新された日時 2012-01-01T12:00:00Z
url string ログドレむンず関連づいおいるURL "https://example.com/drain"
### ログドレむンの䜜成 ``` POST /apps/{app_id_or_name}/log-drains ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
url string ログドレむンず関連づいおいるURL "https://example.com/drain"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"url\":\"https://example.com/drain\"}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "addon": { "id": "01234567-89ab-cdef-0123-456789abcdef" }, "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "url": "https://example.com/drain" } ``` ### ログドレむンの䞀芧 ``` GET /apps/{app_id_or_name}/log-drains ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "addon": { "id": "01234567-89ab-cdef-0123-456789abcdef" }, "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "url": "https://example.com/drain" } ] ``` ### ログドレむンの情報 ``` GET /apps/{app_id_or_name}/log-drains/{drain_id_or_url} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains/$DRAIN_ID_OR_URL \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "addon": { "id": "01234567-89ab-cdef-0123-456789abcdef" }, "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "url": "https://example.com/drain" } ``` ### ログドレむンの削陀 ``` DELETE /apps/{app_id_or_name}/log-drains/{drain_id_or_url} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/apps/$APP_ID_OR_NAME/log-drains/$DRAIN_ID_OR_URL \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "addon": { "id": "01234567-89ab-cdef-0123-456789abcdef" }, "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "url": "https://example.com/drain" } ``` ## ログセッション ログセッションはあなたのアプリケヌションのログからデヌタを流すURLを提䟛したす。出力は、提䟛されおいるLogplexのURLぞHTTP GETメ゜ッドを実行し、そのあず繰り返しその゜ケットから読み取る事で実行されたす。セッションは䜜成されおから分間か接続が成功しおから時間たでは利甚可胜です。アプリケヌションのログぞの継続的なアクセスのために、[ログドレむン](https://devcenter.heroku.com/articles/logging#syslog-drains)の蚭定をしたほうが良いでしょう。 Log sessions provide a URL to stream data from your app logs. Streaming is performed by doing an HTTP GET method on the provided Logplex URL and then repeatedly reading from the socket. Sessions remain available for about 5 minutes after creation or about one hour after connecting. For continuous access to an app's log, you should set up a [log drain](https://devcenter.heroku.com/articles/logging#syslog-drains). ### 属性
名前 タむプ 説明 䟋
created_at datetime ログの接続が䜜成された日時 2012-01-01T12:00:00Z
dyno string 結果を制限するためのDynoの指定 "web.1"
id uuid このログセッションのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
lines number 䞀床に流すログの行数 10
logplex_url string ログを流すためのセッションのURL "https://logplex.heroku.com/sessions/01234567-89ab-cdef-0123-456789abcdef?srv=1325419200"
source string 結果を制限するためのログの゜ヌスの指定 "app"
tail boolean 実行䞭のログを流すかどうか true
updated_at datetime ログのセッションが曎新された日時 2012-01-01T12:00:00Z
### ログセッションの䜜成 ``` POST /apps/{app_id_or_name}/log-sessions ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
dyno string dyno to limit results to "web.1"
lines number number of log lines to stream at once 10
source string log source to limit results to "app"
tail boolean whether to stream ongoing logs true
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/log-sessions \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"dyno\":\"web.1\",\"lines\":10,\"source\":\"app\",\"tail\":true}" ``` #### レスポンス ``` HTTP/1.1 201 Created ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "logplex_url": "https://logplex.heroku.com/sessions/01234567-89ab-cdef-0123-456789abcdef?srv=1325419200", "updated_at": "2012-01-01T12:00:00Z" } ``` ## OAuth認蚌 OAuth認蚌はHerokuのナヌザが自動化やカスタマむズ、プラットフォヌムの䜿甚を拡匵するために暩限付䞎されたクラむアントを衚したす。さらなる情報のためには、[Heroku OAuth ドキュメント](https://devcenter.heroku.com/articles/oauth)を確認しおください。 ### 属性
名前 タむプ 説明 䟋
access_token:expires_in number OAuthのアクセストヌクンが倱効するたでの秒数 7200
access_token:id uuid このOAuthのアクセストヌクンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
access_token:token string 実際のOAuthのアクセストヌクン "01234567-89ab-cdef-0123-456789abcdef"
client:id uuid OAuthで暩限付䞎するクラむアントのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
client:name string OAuthで暩限付䞎するクラむアントの名前 "example"
client:redirect_uri string OAuth暩限付䞎クラむアントで暩限を付䞎した埌にリダむレクトする゚ンドポむント "https://example.com/auth/heroku/callback"
created_at datetime OAuth認蚌が䜜成された日時 2012-01-01T12:00:00Z
description string このOAuth認蚌のヒュヌマンフレンドリヌな説明 "sample authorization"
grant:code string OAuth認、暩限付加甚のコヌド "01234567-89ab-cdef-0123-456789abcdef"
grant:expires_in datetime この認蚌が無効化される日付 2012-01-01T12:00:00Z
grant:id uuid この認蚌付加のナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
id uuid OAuth認蚌のナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
refresh_token:expires_in number OAuthのリフレッシュトヌクンが倱効するたでの秒数; リフレッシュトヌクンが`null`ならずっず倱効しなくなるでしょう 7200
refresh_token:id uuid この認蚌のリフレッシュトヌクンに察するナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
refresh_token:token string 実際のOAuthのリフレッシュトヌクン "01234567-89ab-cdef-0123-456789abcdef"
scope array[string] OAuth認蚌が蚱可するアクセスのスコヌプ ["global"]
updated_at datetime OAuth認蚌が曎新される日時 2012-01-01T12:00:00Z
### OAuth認蚌の䜜成 ``` POST /oauth/authorizations ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
scope array[string] OAuth認蚌が蚱可するアクセスのスコヌプ ["global"]
#### オプションのパラメヌタ
名前 タむプ 説明 䟋
client:id uuid OAuthで暩限付䞎するクラむアントのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
description string このOAuth認蚌のヒュヌマンフレンドリヌな説明 "sample authorization"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/oauth/authorizations \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"client\":{\"id\":\"01234567-89ab-cdef-0123-456789abcdef\"},\"description\":\"sample authorization\",\"scope\":[\"global\"]}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "access_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "client": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback" }, "created_at": "2012-01-01T12:00:00Z", "description": "sample authorization", "grant": { "code": "01234567-89ab-cdef-0123-456789abcdef", "expires_in": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "refresh_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "scope": ["global"], "updated_at": "2012-01-01T12:00:00Z" } ``` ### OAuth認蚌の䞀芧 ``` GET /oauth/authorizations ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/oauth/authorizations \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "access_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "client": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback" }, "created_at": "2012-01-01T12:00:00Z", "description": "sample authorization", "grant": { "code": "01234567-89ab-cdef-0123-456789abcdef", "expires_in": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "refresh_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "scope": ["global"], "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### OAuth認蚌の情報 ``` GET /oauth/authorizations/{authorization_id} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/oauth/authorizations/$AUTHORIZATION_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "access_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "client": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback" }, "created_at": "2012-01-01T12:00:00Z", "description": "sample authorization", "grant": { "code": "01234567-89ab-cdef-0123-456789abcdef", "expires_in": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "refresh_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "scope": ["global"], "updated_at": "2012-01-01T12:00:00Z" } ``` ### OAuth認蚌の削陀 ``` DELETE /oauth/authorizations/{authorization_id} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/oauth/authorizations/$AUTHORIZATION_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "access_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "client": { "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback" }, "created_at": "2012-01-01T12:00:00Z", "description": "sample authorization", "grant": { "code": "01234567-89ab-cdef-0123-456789abcdef", "expires_in": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "id": "01234567-89ab-cdef-0123-456789abcdef", "refresh_token": { "expires_in": "7200", "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "scope": ["global"], "updated_at": "2012-01-01T12:00:00Z" } ``` ## OAuthクラむアント OAuthクラむアントはHerokuのナヌザが自動化やカスタマむズ、プラットフォヌムの䜿甚を拡匵するために暩限付䞎するためのアプリケヌションです。さらなる情報のためには、[Heroku OAuth ドキュメント](https://devcenter.heroku.com/articles/oauth)を確認しおください。 ### 属性
名前 タむプ 説明 䟋
created_at datetime OAuthクラむアントの䜜成された日時 2012-01-01T12:00:00Z
id uuid OAuthクラむアントのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string OAuthクラむアントの名前 "example"
redirect_uri string OAuthクラむアントを䜿っお認蚌した埌にリダむレクトする゚ンドポむント "https://example.com/auth/heroku/callback"
secret string このクラむアント䞋でOAuthの暩限を保持するために䜿われるシヌクレット "01234567-89ab-cdef-0123-456789abcdef"
updated_at datetime OAuthクラむアントが曎新された時の日時 2012-01-01T12:00:00Z
### OAuthクラむアントの䜜成 ``` POST /oauth/clients ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
name string OAuth client name "example"
redirect_uri string endpoint for redirection after authorization with OAuth client "https://example.com/auth/heroku/callback"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/oauth/clients \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"name\":\"example\",\"redirect_uri\":\"https://example.com/auth/heroku/callback\"}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback", "secret": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ``` ### OAuthクラむアントの䞀芧 ``` GET /oauth/clients ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/oauth/clients \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback", "secret": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### OAuthクラむアントの情報 ``` GET /oauth/clients/{client_id} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/oauth/clients/$CLIENT_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback", "secret": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ``` ### OAuthクラむアントの曎新 ``` PATCH /oauth/clients/{client_id} ``` #### オプションのパラメヌタ
名前 タむプ 説明 䟋
name string OAuth client name "example"
redirect_uri string endpoint for redirection after authorization with OAuth client "https://example.com/auth/heroku/callback"
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/oauth/clients/$CLIENT_ID \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"name\":\"example\",\"redirect_uri\":\"https://example.com/auth/heroku/callback\"}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback", "secret": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ``` ### OAuthクラむアントの削陀 ``` DELETE /oauth/clients/{client_id} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/oauth/clients/$CLIENT_ID \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "example", "redirect_uri": "https://example.com/auth/heroku/callback", "secret": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z" } ```

OAuthトヌクン

OAuthトヌクンは暩限付䞎されたクラむアントにアクセスを提䟛し、自動化やカスタマむズ、プラットフォヌムの䜿甚を拡匵するための暩限付䞎をHerokuのナヌザの代わりに行いたす。さらなる情報のためには、Heroku OAuth ドキュメントを確認しおください。

属性

名前 タむプ 説明 䟋
authorization:id uuid OAuthトヌクンの認蚌のナニヌクID 01234567-89ab-cdef-0123-456789abcdef
access_token:expires_in number OAuthのアクセストヌクンが倱効するたでの秒数 2592000
access_token:id uuid OAuthのアクセストヌクンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
access_token:token string OAuthのアクセストヌクンの内容 "01234567-89ab-cdef-0123-456789abcdef"
client:secret string トヌクンを保持するために䜿われるOAuthクラむアントのシヌクレット "01234567-89ab-cdef-0123-456789abcdef"
created_at datetime OAuthトヌクンが䜜成された日時 2012-01-01T12:00:00Z
grant:code string OAuthのWebアプリケヌションの認蚌から取埗した認可コヌド "01234567-89ab-cdef-0123-456789abcdef"
grant:type string 認可リク゚ストのタむプ。`authorization_code`たたは`refresh_token` "authorization_code"
id uuid OAuthトヌクンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
refresh_token:expires_in number OAuthのリフレッシュトヌクンが倱効するたでの秒数; リフレッシュトヌクンが`null`ならずっず倱効しなくなるでしょう 2592000
refresh_token:id uuid OAuthのリフレッシュトヌクンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
refresh_token:token string リフレッシュトヌクンの内容 "01234567-89ab-cdef-0123-456789abcdef"
session:id string OAuthトヌクンセッションのナニヌクなID "01234567-89ab-cdef-0123-456789abcdef"
updated_at datetime OAuthトヌクンが曎新された日時 2012-01-01T12:00:00Z
user:id uuid ナヌザのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
### OAuthトヌクンの䜜成 ``` POST /oauth/tokens ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
grant:type string type of grant requested, one of `authorization_code` or `refresh_token` "authorization_code"
#### オプションのパラメヌタ
名前 タむプ 説明 䟋
client:secret string OAuth client secret used to obtain token "01234567-89ab-cdef-0123-456789abcdef"
grant:code string grant code recieved from OAuth web application authorization "01234567-89ab-cdef-0123-456789abcdef"
refresh_token:token string content of OAuth refresh token "01234567-89ab-cdef-0123-456789abcdef"
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/oauth/tokens \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"client\":{\"secret\":\"01234567-89ab-cdef-0123-456789abcdef\"},\"grant\":{\"code\":\"01234567-89ab-cdef-0123-456789abcdef\",\"type\":\"authorization_code\"},\"refresh_token\":{\"token\":\"01234567-89ab-cdef-0123-456789abcdef\"}}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "authorization": { "id": "01234567-89ab-cdef-0123-456789abcdef" }, "access_token": { "expires_in": 2592000, "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "created_at": "2012-01-01T12:00:00Z", "id": "01234567-89ab-cdef-0123-456789abcdef", "refresh_token": { "expires_in": 2592000, "id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" }, "session": { "id": "01234567-89ab-cdef-0123-456789abcdef" }, "updated_at": "2012-01-01T12:00:00Z", "user": { "id": "01234567-89ab-cdef-0123-456789abcdef" } } ``` ## プラン プランはアプリケヌションに远加されるであろうアドオンの、異なる蚭定を衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime プランが䜜成された日時 2012-01-01T12:00:00Z
description string プランの説明 "Heroku Postgres Dev"
id uuid プランのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string プランのナニヌクな名前 "heroku-postgresql:dev"
price:cents number プランの単䜍圓たりの䟡栌セント 0
price:unit string プランの䟡栌の単䜍 "month"
state string プランのリリヌス状態 "public"
updated_at datetime プランが曎新された日時 2012-01-01T12:00:00Z
### プランの䞀芧 ``` GET /addon-services/{addon_service_id_or_name}/plans ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/addon-services/$ADDON_SERVICE_ID_OR_NAME/plans \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "description": "Heroku Postgres Dev", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev", "price": { "cents": 0, "unit": "month" }, "state": "public", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### プランの情報 ``` GET /addon-services/{addon_service_id_or_name}/plans/{plan_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/addon-services/$ADDON_SERVICE_ID_OR_NAME/plans/$PLAN_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "description": "Heroku Postgres Dev", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "heroku-postgresql:dev", "price": { "cents": 0, "unit": "month" }, "state": "public", "updated_at": "2012-01-01T12:00:00Z" } ``` ## レヌトリミット レヌトリミットはアカりントごずに保有しおいるリク゚ストトヌクンの数を衚しおいたす。この゚ンドポむントに察するリク゚ストはレヌトリミットずしおカりントされたせん。 ### 属性
名前 タむプ 説明 䟋
remaining number 珟圚のむンタヌバルにおける蚱可されたリク゚ストの残り回数 2399
### レヌトリミットの䞀芧 ``` GET /account/rate-limits ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/account/rate-limits \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "remaining": 2399 } ] ``` ## リヌゞョン リヌゞョンはアプリケヌションが実行されおいる地理的な堎所を衚したす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime リヌゞョンが䜜成された日時 2012-01-01T12:00:00Z
description string リヌゞョンの説明 "United States"
id uuid このリヌゞョンのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string このリヌゞョンのナニヌクな名前 "us"
updated_at datetime リヌゞョンが曎新された日時 2012-01-01T12:00:00Z
### リヌゞョンの䞀芧 ``` GET /regions ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/regions \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "description": "United States", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us", "updated_at": "2012-01-01T12:00:00Z" } ] ``` ### リヌゞョンの情報 ``` GET /regions/{region_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/regions/$REGION_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "description": "United States", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "us", "updated_at": "2012-01-01T12:00:00Z" } ``` ## リリヌス リリヌスはHerokuのアプリケヌション向けのコヌド、蚭定倉数、そしおアドオンを衚しおいたす。 ### 属性
名前 タむプ 説明 䟋
created_at datetime リリヌスが䜜成された日時 2012-01-01T12:00:00Z
description string このリリヌスの倉曎の説明 "Added new feature"
id uuid このリリヌスのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
updated_at datetime リヌゞョンが曎新された日時 2012-01-01T12:00:00Z
user:email string リリヌスを䜜成したナヌザのメヌルアドレス "[email protected]"
user:id uuid リリヌスを䜜成したナヌザのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
version number リリヌスに割り圓おられたナニヌクなバヌゞョン 456
### リリヌスの䞀芧 ``` GET /apps/{app_id_or_name}/releases ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/releases \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "created_at": "2012-01-01T12:00:00Z", "description": "Added new feature", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "user": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "version": 456 } ] ``` ### リリヌスの情報 ``` GET /apps/{app_id_or_name}/releases/{release_id_or_version} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/releases/$RELEASE_ID_OR_VERSION \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "created_at": "2012-01-01T12:00:00Z", "description": "Added new feature", "id": "01234567-89ab-cdef-0123-456789abcdef", "updated_at": "2012-01-01T12:00:00Z", "user": { "email": "[email protected]", "id": "01234567-89ab-cdef-0123-456789abcdef" }, "version": 456 } ``` ## SSL゚ンドポむント [SSL ゚ンドポむント](https://devcenter.heroku.com/articles/ssl-endpoint) はHerokuのアプリケヌションぞのHTTPSトラフィック向けに独自のSSL蚌明曞を発行する公開された堎所です。これらのAPIを䜿っおSSL゚ンドポむントを利甚する前にアプリケヌションは`ssl:endpoint`アドオンをむンストヌルする必芁があるこずに泚意しおください。 ### 属性
名前 タむプ 説明 䟋
certificate_chain string 公開認蚌鍵チェヌンの生の内容(䟋: .crt たたは .pem ファむル) "-----BEGIN CERTIFICATE----- ..."
cname string CNAMEレコヌド, ドメむンを刺すアドレス "example.herokussl.com"
created_at datetime ゚ンドポむントが䜜成された日時 2012-01-01T12:00:00-00:00
id uuid SSL゚ンドポむントのナニヌクなID 01234567-89ab-cdef-0123-456789abcdef
name string SSL゚ンドポむントのナニヌクな名前 "tokyo-1234"
private_key string 秘密鍵の内容(䟋: .key ファむル) "-----BEGIN RSA PRIVATE KEY----- ..."
rollback boolean ロヌルバックが実行されるべきかを瀺したす true
updated_at datetime ゚ンドポむントが曎新された日時 2012-01-01T12:00:00-00:00
### SSL゚ンドポむントの䜜成 ``` POST /apps/{app_id_or_name}/ssl-endpoints ``` #### 必須パラメヌタ
名前 タむプ 説明 䟋
certificate_chain string 公開認蚌鍵チェヌンの生の内容(䟋: .crt たたは .pem ファむル) "-----BEGIN CERTIFICATE----- ..."
private_key string 秘密鍵の内容(䟋: .key ファむル) "-----BEGIN RSA PRIVATE KEY----- ..."
#### Curlの䟋 ```term $ curl -n -X POST https://api.heroku.com/apps/$APP_ID_OR_NAME/ssl-endpoints \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"certificate_chain\":\"-----BEGIN CERTIFICATE----- ...\",\"private_key\":\"-----BEGIN RSA PRIVATE KEY----- ...\"}" ``` #### レスポンス ``` HTTP/1.1 201の䜜成d ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "certificate_chain": "-----BEGIN CERTIFICATE----- ...", "cname": "example.herokussl.com", "created_at": "2012-01-01T12:00:00-00:00", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "tokyo-1234", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ### SSL゚ンドポむントの䞀芧 ``` GET /apps/{app_id_or_name}/ssl-endpoints ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/ssl-endpoints \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK Content-Range: ids 01234567-89ab-cdef-0123-456789abcdef..01234567-89ab-cdef-0123-456789abcdef; max=200 ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript [ { "certificate_chain": "-----BEGIN CERTIFICATE----- ...", "cname": "example.herokussl.com", "created_at": "2012-01-01T12:00:00-00:00", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "tokyo-1234", "updated_at": "2012-01-01T12:00:00-00:00" } ] ``` ### SSL゚ンドポむントの情報 ``` GET /apps/{app_id_or_name}/ssl-endpoints/{ssl_endpoint_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -X GET https://api.heroku.com/apps/$APP_ID_OR_NAME/ssl-endpoints/$SSL_ENDPOINT_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "certificate_chain": "-----BEGIN CERTIFICATE----- ...", "cname": "example.herokussl.com", "created_at": "2012-01-01T12:00:00-00:00", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "tokyo-1234", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ### SSL゚ンドポむントの曎新 Updates an SSL Endpoint with a new certificate and private key or [rolls back an SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint#undo) when the `rollback` parameter is given a value of `true`. 
PATCH /apps/{app_id_or_name}/ssl-endpoints/{ssl_endpoint_id_or_name}

オプションのパラメヌタ

名前 タむプ 説明 䟋
certificate_chain string 公開認蚌鍵チェヌンの生の内容(䟋: .crt たたは .pem ファむル) "-----BEGIN CERTIFICATE----- ..."
private_key string 秘密鍵の内容(䟋: .key ファむル) "-----BEGIN RSA PRIVATE KEY----- ..."
rollback boolean ロヌルバックが実行されるべきかを瀺したす true
#### Curlの䟋 ```term $ curl -n -X PATCH https://api.heroku.com/apps/$APP_ID_OR_NAME/ssl-endpoints/$SSL_ENDPOINT_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" \ -H "Content-Type: application/json" \ -d "{\"certificate_chain\":\"-----BEGIN CERTIFICATE----- ...\",\"private_key\":\"-----BEGIN RSA PRIVATE KEY----- ...\",\"rollback\":true}" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "certificate_chain": "-----BEGIN CERTIFICATE----- ...", "cname": "example.herokussl.com", "created_at": "2012-01-01T12:00:00-00:00", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "tokyo-1234", "updated_at": "2012-01-01T12:00:00-00:00" } ``` ### SSL゚ンドポむントの削陀 ``` DELETE /apps/{app_id_or_name}/ssl-endpoints/{ssl_endpoint_id_or_name} ``` #### Curlの䟋 ```term $ curl -n -Xの削陀 https://api.heroku.com/apps/$APP_ID_OR_NAME/ssl-endpoints/$SSL_ENDPOINT_ID_OR_NAME \ -H "Accept: application/vnd.heroku+json; version=3" ``` #### レスポンス ``` HTTP/1.1 200 OK ETag: "0123456789abcdef0123456789abcdef" Last-Modified: Sun, 01 Jan 2012 12:00:00 GMT RateLimit-Remaining: 1200 ``` ```javascript { "certificate_chain": "-----BEGIN CERTIFICATE----- ...", "cname": "example.herokussl.com", "created_at": "2012-01-01T12:00:00-00:00", "id": "01234567-89ab-cdef-0123-456789abcdef", "name": "tokyo-1234", "updated_at": "2012-01-01T12:00:00-00:00" } ```

discordbot: python discordbot.py

⚠ **GitHub.com Fallback** ⚠