cloudsync.credentials.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 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. 
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). 
Each item of this array must be:
[
    "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. 
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
    "username",
    "Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters. 
Get
Type: boolean Default: falseReturn 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: 0This 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: 0This 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: falseCloudCredentialEntry
Type: objectNo Additional Properties
Id
Type: integerName
Type: stringMust be at least 1 characters long
Provider
AzureBlobCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "AZUREBLOB"
"AZUREBLOB" Account
Type: stringMust be at least 1 characters long
Key
Type: stringMust be at least 1 characters long
Endpoint
Default: ""Must be one of:
- ""
"" Must be at least 1 characters long
Must be at most 2083 characters long
B2CredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "B2"
"B2" Account
Type: stringMust be at least 1 characters long
Key
Type: stringMust be at least 1 characters long
BoxCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "BOX"
"BOX" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
DropboxCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "DROPBOX"
"DROPBOX" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
FTPCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "FTP"
"FTP" Host
Type: stringMust be at least 1 characters long
Port
Type: integer Default: 21User
Type: stringMust be at least 1 characters long
Pass
Type: stringGoogleCloudStorageCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "GOOGLE_CLOUD_STORAGE"
"GOOGLE_CLOUD_STORAGE" Service Account Credentials
Type: stringMust be at least 1 characters long
GoogleDriveCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "GOOGLE_DRIVE"
"GOOGLE_DRIVE" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
Team Drive
Type: string Default: ""GooglePhotosCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "GOOGLE_PHOTOS"
"GOOGLE_PHOTOS" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
HTTPCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "HTTP"
"HTTP" Url
Type: stringFormat: uriMust be at least 1 characters long
Must be at most 2083 characters long
HubicCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "HUBIC"
"HUBIC" Token
Type: stringMust be at least 1 characters long
MegaCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "MEGA"
"MEGA" User
Type: stringMust be at least 1 characters long
Pass
Type: stringMust be at least 1 characters long
OneDriveCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "ONEDRIVE"
"ONEDRIVE" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
Drive Type
Type: enum (of string)Must be one of:
- "PERSONAL"
- "BUSINESS"
- "DOCUMENT_LIBRARY"
Drive Id
Type: stringPCloudCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "PCLOUD"
"PCLOUD" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
Hostname
Type: string Default: ""S3CredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "S3"
"S3" Access Key Id
Type: stringMust be at least 1 characters long
Secret Access Key
Type: stringMust be at least 1 characters long
Endpoint
Type: string Default: ""Region
Type: string Default: ""Skip Region
Type: boolean Default: falseSignatures V2
Type: boolean Default: falseMax Upload Parts
Type: integer Default: 10000SFTPCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "SFTP"
"SFTP" Host
Type: stringMust be at least 1 characters long
Port
Type: integer Default: 22User
Type: stringMust be at least 1 characters long
Pass
Default: nullPrivate Key
Default: nullStorjIxCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "STORJ_IX"
"STORJ_IX" Access Key Id
Type: stringMust be at least 1 characters long
Secret Access Key
Type: stringMust be at least 1 characters long
Endpoint
Type: stringFormat: uri Default: "https://gateway.storjshare.io/"Must be at least 1 characters long
Must be at most 2083 characters long
SwiftCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "OPENSTACK_SWIFT"
"OPENSTACK_SWIFT" User
Type: stringMust be at least 1 characters long
Key
Type: stringMust be at least 1 characters long
Auth
Type: stringMust be at least 1 characters long
User Id
Type: string Default: ""Domain
Type: string Default: ""Tenant
Type: string Default: ""Tenant Id
Type: string Default: ""Tenant Domain
Type: string Default: ""Region
Type: string Default: ""Storage Url
Type: string Default: ""Auth Token
Type: string Default: ""Application Credential Id
Type: string Default: ""Application Credential Name
Type: string Default: ""Application Credential Secret
Type: string Default: ""Auth Version
Must be one of:
- 0
- 1
- 2
- 3
Endpoint Type
Must be one of:
- "public"
- "internal"
- "admin"
WebDavCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "WEBDAV"
"WEBDAV" Url
Type: stringFormat: uriMust be at least 1 characters long
Must be at most 2083 characters long
Vendor
Type: enum (of string)Must be one of:
- "NEXTCLOUD"
- "OWNCLOUD"
- "SHAREPOINT"
- "OTHER"
User
Type: stringPass
Type: stringYandexCredentialsModel
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "YANDEX"
"YANDEX" Client Id
Type: string Default: ""Client Secret
Type: string Default: ""Token
Type: stringMust be at least 1 characters long
Required roles: CLOUD_SYNC_READ