# cloudsync.credentials.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: integer

##### Parameter 2: options

#### options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

##

#### Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

##

#### Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: `-` (reverse sort direction), `nulls_first:` (place any null values at the head of the results list), `nulls_last:` (place any null values at the tail of the results list).

No Additional Items

##### Each item of this array must be:

Type: string
Example:

    [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

##

#### Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character `.` may be used to explicitly select only subkeys of the query result.

No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified `query-filters`. The query fails if there specified `query-filters` return no results.

##

#### Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the `limit` query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified `query-filters` to return. When combined wtih the `offset` query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### CredentialsEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the cloud credential.

##

#### Name

Type: string

Human-readable name for the cloud credential.

Must be at least `1` characters long

##

#### Provider

Cloud provider configuration including type and authentication details.

## One of

#### AzureBlobCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Microsoft Azure Blob storage.

Specific value: `"AZUREBLOB"`

##

#### Account

Type: string

Azure Blob Storage account name for authentication.

Must be at least `1` characters long

##

#### Key

Type: string

Azure Blob Storage access key for authentication.

Must be at least `1` characters long

##

#### Endpoint

Default: ""

Custom Azure Blob Storage endpoint URL. Empty string for default endpoints.

## Any of

Type: const
Specific value: `""`
Type: string Format: uri

Must be at least `1` characters long

Must be at most `2083` characters long

#### B2CredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Backblaze B2 storage.

Specific value: `"B2"`

##

#### Account

Type: string

Backblaze B2 account ID for authentication.

Must be at least `1` characters long

##

#### Key

Type: string

Backblaze B2 application key for authentication.

Must be at least `1` characters long

#### BoxCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Box cloud storage.

Specific value: `"BOX"`

##

#### Client Id

Type: string Default: ""

Box OAuth application client ID.

##

#### Client Secret

Type: string Default: ""

Box OAuth application client secret.

##

#### Token

Type: string

Box OAuth access token for API authentication.

Must be at least `1` characters long

#### DropboxCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Dropbox storage.

Specific value: `"DROPBOX"`

##

#### Client Id

Type: string Default: ""

Dropbox OAuth application client ID.

##

#### Client Secret

Type: string Default: ""

Dropbox OAuth application client secret.

##

#### Token

Type: string

Dropbox OAuth access token for API authentication.

Must be at least `1` characters long

#### FTPCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for FTP.

Specific value: `"FTP"`

##

#### Host

Type: string

FTP server hostname or IP address.

Must be at least `1` characters long

##

#### Port

Type: integer Default: 21

FTP server port number.

##

#### User

Type: string

FTP username for authentication.

Must be at least `1` characters long

##

#### Pass

Type: string

FTP password for authentication.

#### GoogleCloudStorageCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Google Cloud Storage.

Specific value: `"GOOGLE_CLOUD_STORAGE"`

##

#### Service Account Credentials

Type: string

JSON service account credentials for Google Cloud Storage authentication.

Must be at least `1` characters long

#### GoogleDriveCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Google Drive.

Specific value: `"GOOGLE_DRIVE"`

##

#### Client Id

Type: string Default: ""

OAuth client ID for Google Drive API access.

##

#### Client Secret

Type: string Default: ""

OAuth client secret for Google Drive API access.

##

#### Token

Type: string

OAuth access token for Google Drive authentication.

Must be at least `1` characters long

##

#### Team Drive

Type: string Default: ""

Google Drive team drive ID or empty string for personal drive.

#### GooglePhotosCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Google Photos.

Specific value: `"GOOGLE_PHOTOS"`

##

#### Client Id

Type: string Default: ""

OAuth client ID for Google Photos API access.

##

#### Client Secret

Type: string Default: ""

OAuth client secret for Google Photos API access.

##

#### Token

Type: string

OAuth access token for Google Photos authentication.

Must be at least `1` characters long

#### HTTPCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for HTTP.

Specific value: `"HTTP"`

##

#### Url

Type: string Format: uri

HTTP URL for file access.

Must be at least `1` characters long

Must be at most `2083` characters long

#### HubicCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Hubic.

Specific value: `"HUBIC"`

##

#### Token

Type: string

OAuth access token for Hubic authentication.

Must be at least `1` characters long

#### MegaCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for MEGA.

Specific value: `"MEGA"`

##

#### User

Type: string

MEGA username for authentication.

Must be at least `1` characters long

##

#### Pass

Type: string

MEGA password for authentication.

Must be at least `1` characters long

#### OneDriveCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for OneDrive.

Specific value: `"ONEDRIVE"`

##

#### Client Id

Type: string Default: ""

OAuth client ID for OneDrive API access.

##

#### Client Secret

Type: string Default: ""

OAuth client secret for OneDrive API access.

##

#### Token

Type: string

OAuth access token for OneDrive authentication.

Must be at least `1` characters long

##

#### Drive Type

Type: enum (of string)

Type of OneDrive to access.

##### Must be one of:

- "PERSONAL"
- "BUSINESS"
- "DOCUMENT_LIBRARY"

##

#### Drive Id

Type: string

OneDrive drive identifier.

#### PCloudCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for pCloud.

Specific value: `"PCLOUD"`

##

#### Client Id

Type: string Default: ""

OAuth client ID for pCloud API access.

##

#### Client Secret

Type: string Default: ""

OAuth client secret for pCloud API access.

##

#### Token

Type: string

OAuth access token for pCloud authentication.

Must be at least `1` characters long

##

#### Hostname

Type: string Default: ""

pCloud hostname or empty string for default.

#### S3CredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for S3-compatible storage.

Specific value: `"S3"`

##

#### Access Key Id

Type: string

S3 access key ID for authentication.

Must be at least `1` characters long

##

#### Secret Access Key

Type: string

S3 secret access key for authentication.

Must be at least `1` characters long

##

#### Endpoint

Default: ""

S3-compatible endpoint URL or empty string for AWS S3.

## Any of

Type: const
Specific value: `""`
Type: string Format: uri

Must be at least `1` characters long

Must be at most `2083` characters long

##

#### Region

Type: string Default: ""

S3 region or empty string for default.

##

#### Skip Region

Type: boolean Default: false

Whether to skip region validation.

##

#### Signatures V2

Type: boolean Default: false

Whether to use AWS Signature Version 2.

##

#### Max Upload Parts

Type: integer Default: 10000

Maximum number of parts for multipart uploads.

#### SFTPCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for SFTP.

Specific value: `"SFTP"`

##

#### Host

Type: string

SFTP server hostname or IP address.

Must be at least `1` characters long

##

#### Port

Type: integer Default: 22

SFTP server port number.

##

#### User

Type: string

SFTP username for authentication.

Must be at least `1` characters long

##

#### Pass

Default: null

SFTP password for authentication or `null` for key-based auth.

## Any of

Type: string
Type: null

##

#### Private Key

Default: null

SSH private key ID for authentication or `null` for password auth.

## Any of

Type: integer
Type: null

#### StorjIxCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Storj decentralized storage.

Specific value: `"STORJ_IX"`

##

#### Access Key Id

Type: string

Storj S3-compatible access key ID for authentication.

Must be at least `1` characters long

##

#### Secret Access Key

Type: string

Storj S3-compatible secret access key for authentication.

Must be at least `1` characters long

##

#### Endpoint

Type: string Format: uri Default: "https://gateway.storjshare.io/"

Storj gateway endpoint URL for S3-compatible access.

Must be at least `1` characters long

Must be at most `2083` characters long

#### SwiftCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for OpenStack Swift storage.

Specific value: `"OPENSTACK_SWIFT"`

##

#### User

Type: string

Swift username for authentication.

Must be at least `1` characters long

##

#### Key

Type: string

Swift password or API key for authentication.

Must be at least `1` characters long

##

#### Auth

Type: string

Swift authentication URL endpoint.

Must be at least `1` characters long

##

#### User Id

Type: string Default: ""

Swift user ID for authentication.

##

#### Domain

Type: string Default: ""

Swift domain name for authentication.

##

#### Tenant

Type: string Default: ""

Swift tenant name for multi-tenancy.

##

#### Tenant Id

Type: string Default: ""

Swift tenant ID for multi-tenancy.

##

#### Tenant Domain

Type: string Default: ""

Swift tenant domain name.

##

#### Region

Type: string Default: ""

Swift region name for geographic distribution.

##

#### Storage Url

Type: string Default: ""

Swift storage URL endpoint.

##

#### Auth Token

Type: string Default: ""

Swift authentication token for pre-authenticated access.

##

#### Application Credential Id

Type: string Default: ""

Swift application credential ID for authentication.

##

#### Application Credential Name

Type: string Default: ""

Swift application credential name for authentication.

##

#### Application Credential Secret

Type: string Default: ""

Swift application credential secret for authentication.

##

#### Auth Version

Swift authentication API version.

- `0`: Legacy auth
- `1`: TempAuth
- `2`: Keystone v2.0
- `3`: Keystone v3
- `null`: Auto-detect

## Any of

Type: enum (of integer)

##### Must be one of:

- 0
- 1
- 2
- 3

Type: null

##

#### Endpoint Type

Swift endpoint type to use.

- `public`: Public endpoint (default)
- `internal`: Internal network endpoint
- `admin`: Administrative endpoint
- `null`: Use default

## Any of

Type: enum (of string)

##### Must be one of:

- "public"
- "internal"
- "admin"

Type: null

#### WebDavCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for WebDAV servers.

Specific value: `"WEBDAV"`

##

#### Url

Type: string Format: uri

WebDAV server URL endpoint.

Must be at least `1` characters long

Must be at most `2083` characters long

##

#### Vendor

Type: enum (of string)

WebDAV server vendor type for compatibility optimizations.

- `NEXTCLOUD`: Nextcloud server
- `OWNCLOUD`: ownCloud server
- `SHAREPOINT`: Microsoft SharePoint
- `OTHER`: Generic WebDAV server

##### Must be one of:

- "NEXTCLOUD"
- "OWNCLOUD"
- "SHAREPOINT"
- "OTHER"

##

#### User

Type: string

WebDAV username for authentication.

##

#### Pass

Type: string

WebDAV password for authentication.

#### YandexCredentialsModel

Type: object
No Additional Properties

##

#### Type

Type: const

Cloud provider type identifier for Yandex Disk storage.

Specific value: `"YANDEX"`

##

#### Client Id

Type: string Default: ""

Yandex OAuth application client ID.

##

#### Client Secret

Type: string Default: ""

Yandex OAuth application client secret.

##

#### Token

Type: string

Yandex OAuth access token for API authentication.

Must be at least `1` characters long

Required roles: CLOUD_SYNC_READ