# Equinix API

Equinix™は、にアクセスできるRESTful HTTP APIを提供しています。`https://api.equinix.com/`本書では、APIとその使用方法について説明します。

APIを利用すると、プロジェクト、デバイス、接続、注文、コロケーション展開、サポートチケット、Identity & Access Managementなど、エクイニクスのリソースとプログラムでやり取りできます。

## Equinix APIの利用[​](#equinix-apiの利用 "への直接リンクEquinix APIの利用")

APIの使用は、認可フローとリクエストフローに分けることができます。

API経由でエクイニクスの製品とやり取りするには、次のことが必要です：

* Equinix Customer PortalアカウントまたはOIDCプロバイダ。
* 製品固有の作成、変更、削除権限。

### ユーザー認証フロー[​](#ユーザー認証フロー "への直接リンクユーザー認証フロー")

1. カスタマーポータルでアプリケーションの登録と認証を行います。

2. コンシューマキー、コンシューマシークレット、およびユーザー認証情報を使用してを呼び出し、アクセスおよび更新トークン情報をリクエストします。[`/oauth2/v1/token`](https://docs.equinix.com/ja/api-catalog/accesstokenv1/oauth2-token/getoauth2accesstoken.md)

   ![Equinix APIからOAuthアクセストークンとリフレッシュトークンを取得するクライアントアプリケーションを示すユーザー認証フローの図](https://docs.equinix.com/ja/assets/images/authorization-flow-968fdaa494b91626a4d3176b604cd49e.jpg)

3. リクエストは、短命の OAuth アクセストークンと関連するリフレッシュトークンを返します。

詳細および詳細な手順については、「[API認証」を](https://docs.equinix.com/ja/equinix-api/api-authentication.md)参照してください。

### OIDCトークン認証フロー[​](#oidcトークン認証フロー "への直接リンクOIDCトークン認証フロー")

1. カスタマーポータルまたはEquinix APIで[OIDCプロバイダを作成します。](https://docs.equinix.com/ja/iam/oidc/create-oidc-provider.md)

2. IDプロバイダのトークンとスコープを使用してエンドポイントを呼び出し、アクセスをリクエストします。`/v1/token`

<!-- -->

1. リクエストは短命のアクセストークンを返します。

詳細については、「[OIDC API認証」を](https://docs.equinix.com/ja/equinix-api/oidc-api-authentication.md)参照してください。

### リクエストの流れ[​](#リクエストの流れ "への直接リンクリクエストの流れ")

1. 有効な OAuth アクセストークンを使用してリクエストを認可し、必要な認可ヘッダーを使用して API エンドポイントを呼び出します。

   ![APIゲートウェイを呼び出しているクライアントを示すAPIリクエストフローの図。このゲートウェイはリクエストをEquinix APIに転送し、レスポンスを返します。](https://docs.equinix.com/ja/assets/images/request-flow-1b070775deacbc1b9dc448520b67aef4.png)

2. APIゲートウェイはリクエストを検証し、関連するEquinix APIを呼び出します。

3. API ゲートウェイによってレスポンスが受信されます。

4. 応答が送信されます。

## Terraformを使用したコードとしてのインフラストラクチャ[​](#terraformを使用したコードとしてのインフラストラクチャ "への直接リンクTerraformを使用したコードとしてのインフラストラクチャ")

Equinixは、REST APIに加えて、インフラストラクチャをコードとして使用してEquinixリソースを管理できるテラ[フォームプロバイダも](https://docs.equinix.com/ja/terraform.md)提供しています。TerraformプロバイダはEquinix APIを包含し、インフラストラクチャを定義および管理するための宣言的な方法を提供します。

Equinixテラフォームプロバイダは以下をサポートしています。

* **Equinix Fabric** -仮想接続、クラウドルーター、ストリーム、正確な時間
* **Network Edge** -仮想ネットワークデバイス

完全なドキュメント、例、利用可能なリソースについては、[テラフォームプロバイダのドキュメントを](https://docs.equinix.com/ja/terraform.md)参照してください。

## APIリファレンス[​](#apiリファレンス "への直接リンクAPIリファレンス")

Equinix APIは、バージョン管理された機能グループで構成されています。各機能グループには、そのグループに関連する操作を実行できる一連のAPIエンドポイントが含まれています。

API参照はOpenAPI形式で提供されており、リクエストとレスポンスの形式、必須パラメータ、リクエスト例など、各エンドポイントに関する詳細情報が含まれています。Equinix製品ドキュメント全体に、説明されている製品またはサービスに対応する「APIリファレンス」へのリンクがあります。

官能基ごとのすべてのEquinix APIリファレンスのライブラリを表示するには、[APIカタログを](https://docs.equinix.com/ja/api-catalog)参照してください。次のナビゲーションツリーを使用して、すべてのEquinix API参照へのリンクを検索することもできます。各先行APIパスは、このビュー内の対応するAPIリファレンスにリンクされます。

🔍 Filter APIs by name or path...

api.equinix.com

├─ ► [billing](https://docs.equinix.com/ja/api-catalog/basv2.md "Platform Billing Account APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/basv2.md "Platform Billing Account APIs")

<!-- -->

[Platform Billing Account APIs](https://docs.equinix.com/ja/api-catalog/basv2.md "Platform Billing Account APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/basv2.md "Platform Billing Account APIs")

├─ ▼ colocations

│

<!-- -->

└─ ▼ v2

│

<!-- -->

├─ [connectionServices](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup")

<!-- -->

[Lookup](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup")

│

<!-- -->

├─ [locations](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup")

<!-- -->

[Lookup](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup")

│

<!-- -->

├─ ▼ orders

│ │

<!-- -->

├─ ► [{orderId}](https://docs.equinix.com/ja/api-catalog/ordersv2.md "Orders")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/ordersv2.md "Orders")

<!-- -->

[Orders](https://docs.equinix.com/ja/api-catalog/ordersv2.md "Orders")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/ordersv2.md "Orders")

│ │

<!-- -->

├─ ► [crossConnects](https://docs.equinix.com/ja/api-catalog/crossconnectsv2.md "Cross Connect")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/crossconnectsv2.md "Cross Connect")

<!-- -->

[Cross Connect](https://docs.equinix.com/ja/api-catalog/crossconnectsv2.md "Cross Connect")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/crossconnectsv2.md "Cross Connect")

│ │

<!-- -->

├─ ► [shipments](https://docs.equinix.com/ja/api-catalog/shipmentsv2.md "Shipments")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/shipmentsv2.md "Shipments")

<!-- -->

[Shipments](https://docs.equinix.com/ja/api-catalog/shipmentsv2.md "Shipments")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/shipmentsv2.md "Shipments")

│ │

<!-- -->

└─ ► [workVisits](https://docs.equinix.com/ja/api-catalog/workvisitsv2.md "Scheduling Work Visits")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/workvisitsv2.md "Scheduling Work Visits")

<!-- -->

[Scheduling Work Visits](https://docs.equinix.com/ja/api-catalog/workvisitsv2.md "Scheduling Work Visits")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/workvisitsv2.md "Scheduling Work Visits")

│

<!-- -->

├─ ► [patchPanels](https://docs.equinix.com/ja/api-catalog/lookupv2.md "Lookup")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/lookupv2.md "Lookup")

<!-- -->

[Lookup](https://docs.equinix.com/ja/api-catalog/lookupv2.md "Lookup")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/lookupv2.md "Lookup")

│

<!-- -->

├─ [providers](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup")

<!-- -->

[Lookup](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup")

│

<!-- -->

└─ [supportPlans](https://docs.equinix.com/ja/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans")

<!-- -->

[Smarthands Support Plans](https://docs.equinix.com/ja/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans")

├─ ► [dcim](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[Equinix SmartView APIs](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

├─ ► [diloa](https://docs.equinix.com/ja/api-catalog/diloav1.md "Digital LOA API")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/diloav1.md "Digital LOA API")

<!-- -->

[Digital LOA API](https://docs.equinix.com/ja/api-catalog/diloav1.md "Digital LOA API")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/diloav1.md "Digital LOA API")

├─ ► [environment](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[Equinix SmartView APIs](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

├─ ► [fabric](https://docs.equinix.com/ja/api-catalog/fabricv4.md "Equinix Fabric API v4")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/fabricv4.md "Equinix Fabric API v4")

<!-- -->

[Equinix Fabric API v4](https://docs.equinix.com/ja/api-catalog/fabricv4.md "Equinix Fabric API v4")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/fabricv4.md "Equinix Fabric API v4")

├─ ▼ internetAccess

│

<!-- -->

├─ ► [v1](https://docs.equinix.com/ja/api-catalog/internetaccessv1.md "Equinix Internet Access API")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/internetaccessv1.md "Equinix Internet Access API")

<!-- -->

[Equinix Internet Access API](https://docs.equinix.com/ja/api-catalog/internetaccessv1.md "Equinix Internet Access API")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/internetaccessv1.md "Equinix Internet Access API")

│

<!-- -->

└─ ► [v2](https://docs.equinix.com/ja/api-catalog/internetaccessv2.md "Equinix Internet Access API")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/internetaccessv2.md "Equinix Internet Access API")

<!-- -->

[Equinix Internet Access API](https://docs.equinix.com/ja/api-catalog/internetaccessv2.md "Equinix Internet Access API")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/internetaccessv2.md "Equinix Internet Access API")

├─ ► [ne](https://docs.equinix.com/ja/api-catalog/network-edgev1.md "Network Edge APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/network-edgev1.md "Network Edge APIs")

<!-- -->

[Network Edge APIs](https://docs.equinix.com/ja/api-catalog/network-edgev1.md "Network Edge APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/network-edgev1.md "Network Edge APIs")

├─ ► [notifications](https://docs.equinix.com/ja/api-catalog/unifiednotificationv2.md "Notifications API")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/unifiednotificationv2.md "Notifications API")

<!-- -->

[Notifications API](https://docs.equinix.com/ja/api-catalog/unifiednotificationv2.md "Notifications API")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/unifiednotificationv2.md "Notifications API")

├─ ► [oauth2](https://docs.equinix.com/ja/api-catalog/accesstokenv1.md "Equinix API Authentication")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/accesstokenv1.md "Equinix API Authentication")

<!-- -->

[Equinix API Authentication](https://docs.equinix.com/ja/api-catalog/accesstokenv1.md "Equinix API Authentication")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/accesstokenv1.md "Equinix API Authentication")

├─ ► [power](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[Equinix SmartView APIs](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

├─ ► [resourceManager](https://docs.equinix.com/ja/api-catalog/getprojectsv2.md "Project APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/getprojectsv2.md "Project APIs")

<!-- -->

[Project APIs](https://docs.equinix.com/ja/api-catalog/getprojectsv2.md "Project APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/getprojectsv2.md "Project APIs")

├─ ► [securecabinet](https://docs.equinix.com/ja/api-catalog/securecabinetv1.md "Secure Cabinet API")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/securecabinetv1.md "Secure Cabinet API")

<!-- -->

[Secure Cabinet API](https://docs.equinix.com/ja/api-catalog/securecabinetv1.md "Secure Cabinet API")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/securecabinetv1.md "Secure Cabinet API")

├─ ► [smartview](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[Equinix SmartView APIs](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/smartviewv2.md "Equinix SmartView APIs")

├─ ► [support](https://docs.equinix.com/ja/api-catalog/supportv2.md "Case Management API")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/supportv2.md "Case Management API")

<!-- -->

[Case Management API](https://docs.equinix.com/ja/api-catalog/supportv2.md "Case Management API")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/supportv2.md "Case Management API")

└─ ▼ v2

<!-- -->

├─ ► [invoices](https://docs.equinix.com/ja/api-catalog/billingv2.md "Billing APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/billingv2.md "Billing APIs")

<!-- -->

[Billing APIs](https://docs.equinix.com/ja/api-catalog/billingv2.md "Billing APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/billingv2.md "Billing APIs")

<!-- -->

├─ ► [quotes](https://docs.equinix.com/ja/api-catalog/quotesv2.md "Quote APIs")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/quotesv2.md "Quote APIs")

<!-- -->

[Quote APIs](https://docs.equinix.com/ja/api-catalog/quotesv2.md "Quote APIs")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/quotesv2.md "Quote APIs")

<!-- -->

└─ ► [tickets](https://docs.equinix.com/ja/api-catalog/ticketsv2.md "Tickets")

<!-- -->

[ (](https://docs.equinix.com/ja/api-catalog/ticketsv2.md "Tickets")

<!-- -->

[Tickets](https://docs.equinix.com/ja/api-catalog/ticketsv2.md "Tickets")

<!-- -->

[)](https://docs.equinix.com/ja/api-catalog/ticketsv2.md "Tickets")