ソース

ソース操作

すべてのソース操作には ソース 権限が必要です。

エンドポイント	メソッド	説明
`sources`	GET	アカウントのすべてのソースをリストします。
`sources`	POST	新しいソースを作成（およびデプロイ）します。
`sources/:source_id`	GET	`source_id` によって単一のソースの詳細を取得します。
`sources/:source_id`	PATCH	単一のソースを更新します。デプロイメントに影響を与える変更は、自動的にソースのデプロイをトリガーします。レンダリングに影響を与える変更は、ソースのデプロイが完了するまで効果がありません。

ソースのフィルター

フィルター	タイプ	サポートされるソースの種類
`deployment.azure_bucket`	String	Azure
`deployment.bucket_name`	String	S3互換
`deployment.custom_domains`	String	すべて
`deployment.gcs_bucket`	String	GCS
`deployment.imgix_subdomains`	String	すべて
`deployment.region`	String	S3互換
`deployment.s3_bucket`	String	S3
`deployment.storage_provider`	String	S3互換
`deploymeny.type`	String	すべて。可能な値は `azure`、`gcs`、`s3`、`webfolder`、`webproxy`、`s3_compatible`
`deployment.webfolder_base_url`	String	Webフォルダー
`enabled`	Boolean	すべて
`name`	String	すべて

ソースのソート

date_deployed
enabled
name

ソース属性

フィールド	タイプ	更新可能？	説明
`date_deployed`	Integer	いいえ	このソースがデプロイされたUNIXタイムスタンプ。
`deployment`*	Object	はい	下のソースデプロイメントテーブルを参照してください。
`deployment_status`	String	いいえ	現在のデプロイメントステータス。可能な値は `deploying`、`deployed`、`disabled`、`deleted` です。
`enabled`	Boolean	はい	ソースが有効かどうか。無効なソースは、キャッシュされていないアセットに対して `410 Gone` を返します。
`name`*	String	はい	ソースの表示名。アセットの提供方法には影響しません。
`secure_url_token`	String	いいえ	アセットのセキュリティに使用される署名トークン。`deployment.secure_url_enabled` が `true` の場合のみ表示されます。

* ソース作成時に必須

ソース展開属性

ソース展開: すべてのソースタイプ

フィールド	タイプ	更新可能？	説明
`allows_upload`	Boolean	いいえ	imgixがOriginにアップロードするためのこのソースの適切な権限を持っているかどうか。 `azure`、`gcs`、または`s3`ソースタイプにのみ適用されます。アップロードの詳細については、アセットのアップロードを参照してください。
`annotation`	String	はい	特定の展開に関するコメント。デフォルトは「`<user>`によってソース用に新しい展開が作成されました」です。
`cache_ttl_behavior`	String	はい	imgixイメージのTTLがどのように設定されるかを決定するポリシー。受け入れられる値: `respect_origin`、`override_origin`、`enforce_minimum`。デフォルトは `respect_origin`です。キャッシュ動作の詳細はこちらをご覧ください。
`cache_ttl_error`	Integer	はい	Originからファイルを取得できないときに提供される任意のエラーイメージのTTL（秒単位）。最小値は1、最大値は31536000です。デフォルトは300です。キャッシュ動作の詳細はこちらをご覧ください。
`cache_ttl_value`	Integer	はい	`cache_ttl_behavior`で設定されたキャッシュモードに使用されるTTL（秒）。最小値は1800、最大値は31536000です。デフォルトは31536000です。キャッシュ動作の詳細はこちらをご覧ください。
`crossdomain_xml_enabled`	Boolean	はい	リクエストされた場合にこのソースがクロスドメインポリシーファイルを提供する必要があるかどうか。クロスドメインポリシーファイルの詳細はこちらをご覧ください。
`custom_domains`	List	はい	画像にアクセスするために使用する `imgix.net` ドメイン以外のドメイン。カスタムドメインはすべてのソースで一意である必要があり、有効なドメインである必要があります。デフォルトは `[]` です。カスタムドメインの詳細はこちらをご覧ください。
`default_params`	Object	はい	このソースへのすべてのリクエストに設定するパラメーター。オブジェクトキーはパラメーターで、オブジェクト値はパラメーター値です。すべてのキー/値は有効なimgixパラメーター/値である必要があります。デフォルトは `{}` です。デフォルトパラメーターの詳細はこちらをご覧ください。
`image_error`	String	はい	リクエストがエラーになった場合に代わりにimgixが提供する画像URL。受け入れられる値は有効な絶対URLです。デフォルトは `null` です。エラー画像の詳細はこちらをご覧ください。
`image_error_append_qs`	Boolean	はい	`image_error` で説明されているURLに送信されたリクエストのパラメーターをimgixが渡すかどうか。デフォルトは `false` です。エラー画像の詳細はこちらをご覧ください。
`image_missing`	String	はい	リクエストが見つからない画像になった場合にimgixが代わりに提供する画像URL。受け入れられる値は有効な絶対URLです。デフォルトは `null` です。デフォルト画像の詳細はこちらをご覧ください。
`image_missing_append_qs`	Boolean	はい	`image_missing` で説明されているURLに送信されたリクエストのパラメーターをimgixが渡すかどうか。デフォルトは `false` です。デフォルト画像の詳細はこちらをご覧ください。
`imgix_subdomains`*	List	はい	画像にアクセスするために `*.imgix.net` で使用するサブドメイン。ドメインはすべてのソースで一意であり、有効なサブドメインである必要があります。 `imgix.net` は暗黙的に含まれているため、サブドメインのみが受け入れられます。たとえば、`foo.imgix.net` を使用する場合は、 `["foo"]` のみを渡す必要があります。少なくとも1つのサブドメインが必要です。
`secure_url_enabled`	Boolean	はい	リクエストが有効であるためには、`secure_url_token` で署名する必要があるかどうか。画像のセキュリティの詳細はこちらをご覧ください。
`type`*	String	はい	ソースタイプ。受け入れられる値: `azure`、`gcs`、`s3`、`webfolder`、`webproxy`, `s3_compatible`。ソースタイプの詳細はこちらをご覧ください。ソースタイプを更新する場合、そのソースタイプに必要なパラメーターも提供する必要があります。

* ソース作成時に必須

ソース展開: Amazon S3固有のフィールド

フィールド	タイプ	更新可能？	説明
`s3_access_key`*	String	はい	アクセスキーID。
`s3_bucket`*	String	はい	S3バケット名。
`s3_prefix`	String	はい	S3でイメージを解決する前にイメージパスの先頭に追加されるフォルダー接頭辞。デフォルトは `null` です。
`s3_secret_key`*	String	はい	S3 Secret Access Key。注：後続のGETリクエストでは返されません。

* ソース作成時に必須

ソース展開: Google Cloud Storage固有のフィールド

フィールド	タイプ	更新可能？	説明
`gcs_access_key`*	String	はい	GCSアクセスキー。
`gcs_bucket`*	String	はい	GCSバケット名。
`gcs_prefix`	String	はい	GCSでイメージを解決する前にイメージパスの先頭に追加されるフォルダー接頭辞。デフォルトは `null` です。
`gcs_secret_key`*	String	はい	GCS Secret Access Key。注：後続のGETリクエストでは返されません。

* ソース作成時に必須

ソース展開: Microsoft Azure固有のフィールド

フィールド	タイプ	更新可能？	説明
`azure_account`*	String	はい	Azureストレージアカウント名。
`azure_bucket`*	String	はい	Azureストレージコンテナー名。
`azure_prefix`	String	はい	Azureでイメージを解決する前にイメージパスの先頭に追加されるフォルダー接頭辞。デフォルトは `null` です。
`azure_sas_string`*	String	はい	Azure Shared Access Signature String。注：後続のGETリクエストでは返されません。
`azure_service_type`*	String	はい	Azureストレージタイプ。受け入れられる値は `blob` または `file` です。

* ソース作成時に必須

ソース展開: Webフォルダー固有のフィールド

フィールド	タイプ	更新可能？	説明
`webfolder_base_url`*	String	はい	オリジンから取得する際にイメージパスの前に前置されるプロトコル、ホスト、およびパス情報（ `http://www.yourcompany.com/images/` のようなもの）。
`username`	String	はい	オリジンへのBasic認証ヘッダーの送信に使用されるユーザー名。出力は `Basic {base64encode(username:password)}` となります。 `:` や制御文字を含めることはできません
`password`	String	はい	オリジンへのBasic認証ヘッダーの送信に使用されるパスワード。出力は `Basic {base64encode(username:password)}` となります。 `:` や制御文字を含めることはできません
`password_encrypted`	String	いいえ	Basic認証ヘッダーのための暗号化されたパスワード値。ソースに対する `GET` リクエストで送信されます
`request_handshake`	String	はい	カスタムヘッダー認証に使用される32文字のラテン文字列。
`request_handshake_encrypted`	String	いいえ	オリジン認証のための暗号化された `request_handshake` 値。ソースに対する `GET` リクエストで送信されます
`request_signing_key`	String	はい	パーリクエスト署名オリジン認証に使用される32文字のラテン文字列。
`request_signing_key_encrypted`	String	いいえ	オリジン認証のための暗号化された `request_signing_key` 値。ソースに対する `GET` リクエストで送信されます

* ソース作成時に必須

ソース展開: S3互換固有のフィールド

フィールド	タイプ	更新可能？	説明
`access_key_id`*	String	はい	S3互換のアクセスキー
`bucket_name`*	String	はい	S3互換のバケット名
`endpoint_url`*	String	はい	APIがサーバーに対する特定のリクエストを受け取るデジタルロケーション。
`region`*	String	はい	データセンターが物理的に位置する場所。
`secret_key`*	String	はい	S3互換のシークレットアクセスキー
`storage_provider`*	String	はい	S3互換のストレージプロバイダーの名前。受け入れられる値は `DigitalOcean`、`Linode`、`Wasabi` です。

* ソース作成時に必須

ソース展開: Webプロキシ固有のフィールド

フィールド	タイプ	更新可能？	説明
`username`	String	はい	オリジンへのBasic認証ヘッダーの送信に使用されるユーザー名。出力は `Basic {base64encode(username:password)}` となります。 `:` や制御文字を含めることはできません
`password`	String	はい	オリジンへのBasic認証ヘッダーの送信に使用されるパスワード。出力は `Basic {base64encode(username:password)}` となります。 `:` や制御文字を含めることはできません
`password_encrypted`	String	いいえ	Basic認証ヘッダーのための暗号化されたパスワード値。ソースに対する `GET` リクエストで送信されます
`request_handshake`	String	はい	カスタムヘッダー認証に使用される32文字のラテン文字列。
`request_handshake_encrypted`	String	いいえ	オリジン認証のための暗号化された `request_handshake` 値。ソースに対する `GET` リクエストで送信されます
`request_signing_key`	String	はい	パーリクエスト署名オリジン認証に使用される32文字のラテン文字列。
`request_signing_key_encrypted`	String	いいえ	オリジン認証のための暗号化された `request_signing_key` 値。ソースに対する `GET` リクエストで送信されます

ソースの例

新しいS3ソースの作成

POST /api/v1/sources
 
{
  "data": {
    "attributes": {
      "name": "example_test",
      "deployment": {
        "type": "s3",
        "s3_access_key": "$YOUR_S3_ACCESS_KEY",
        "s3_bucket": "$YOUR_S3_BUCKET",
        "s3_secret_key": "$YOUR_S3_SECRET_KEY",
        "imgix_subdomains": [
          "$YOUR_IMGIX_SUBDOMAIN"
        ]
      }
    },
    "type": "sources"
  }
}

{
  "data": {
    "attributes": {
      "date_deployed": 1666823606,
      "deployment": {
        "annotation": "New deployment created for source by imgix.",
        "cache_ttl_behavior": "respect_origin",
        ...
      },
      "deployment_status": "deploying",
      "enabled": true,
      "name": "example_test"
    },
    "id": "6359b5ba8147da20e8edfdd5",
    "type": "sources"
  },
  "included": [],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    ...
  }
}

ソースのバケット構成の更新

PATCH /api/v1/sources/6359b5ba8147da20e8edfdd5
 
{
  "data": {
    "attributes": {
      "name": "example_source",
      "deployment": {
        "cache_ttl_value": 31536000,
        "s3_access_key": "$YOUR_S3_ACCESS_KEY",
        "s3_bucket": "$YOUR_S3_BUCKET",
        "s3_secret_key": "$YOUR_S3_SECRET_KEY",
      }
    },
    "id": "6359b5ba8147da20e8edfdd5",
    "type": "sources"
  }
}

{
  "data": {
    "attributes": {
      "date_deployed": 1666822829,
      "deployment": {
        "annotation": "New deployment created for source by imgix.",
        "cache_ttl_behavior": "respect_origin",
        ...
      },
      ...
    },
    "id": "6359b5ba8147da20e8edfdd5",
    "type": "sources"
  },
  "included": [],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    ...
  }
}

新しいS3互換ソースの作成

POST api/v1/sources/source_id
 
{
    "data": {
        "attributes": {
            "name": "new_source_name",
            "deployment": {
                "type": "s3_compatible",
                "storage_provider": "$YOUR_STORAGE_PROVIDER",
                "access_key_id": "$YOUR_ACCESS_KEY",
                "bucket_name": "$YOUR_BUCKET_NAME",
                "secret_key": "$YOUR_SECRET_KEY",
                "endpoint_url": "$YOUR_ENDPOINT_URL",
                "region": "$YOUR_REGION",
                "imgix_subdomains": [
                    "$YOUR_IMGIX_SUBDOMAIN"
                ]
            }
        },
        "type": "sources"
    },
    "jsonapi": {
        "version": "1.0"
    }
}

WebフォルダーソースをS3互換ソースに変換

PATCH api/v1/sources/source_id
 
{
  "data": {
    "attributes": {
      "name": "sourceName",
      "deployment": {
        "type": "s3_compatible",
        "storage_provider": "$YOUR_STORAGE_PROVIDER",
        "access_key_id": "$YOUR_ACCESS_KEY",
        "bucket_name": "$YOUR_BUCKET_NAME",
        "secret_key": "$YOUR_SECRET_KEY",
        "endpoint_url": "$YOUR_ENDPOINT_URL",
        "region": "$YOUR_REGION",
        "imgix_subdomains": ["$YOUR_IMGIX_SUBDOMAIN"]
      }
    },
    "id": "source_id",
    "type": "sources"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

レポート