Service credentials

Use these operations to get, create, and manage credentials for third-party services.

Operations

Retrieve service credentials

Request

Retrieves a list of service credentials.

Security
SecretApiKey or JWT
Path
typestringrequired

Type of service credential.

Enum:"smtp""webhook""mailgun""sendgrid""aws-ses""oauth2""postmark""experian""taxjar""avalara"
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/service-credentials/{type}?filter=string&limit=0&offset=0&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of service credentials retrieved.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
Array [
idstring, <= 36 charactersread-only

ID of the credential.

Example:"crd_0YV9Y706QGCB39FQD380G1ZHZH"
statusstringread-only

Status of the credential.

Enum ValueDescription
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTimestring or null, (date-time)read-only

Date and time when the credential is deactivated.

typestringrequired

Type of credential.

Value:"smtp"
Discriminator
hoststringrequired

SMTP host name.

portinteger, [ 1 .. 65535 ]

SMTP port value.

Default:25
encryptionstring

Encryption value.

Default:"none"
Enum:"none""tls""ssl"
authobject(SmtpAuthorization)
hashstring, <= 36 charactersread-onlydeprecated

ID of the credential. Use the id field instead.

Example:"crd_0YV9Y706QGCB39FQD380G1ZHZH"
]
Response
[
  {
    "id": "crd_0YV9Y706QGCB39FQD380G1ZHZH",
    "hash": "crd_0YV9Y706QGCB39FQD380G1ZHZH",
    "status": "active",
    "deactivationTime": "2019-08-24T14:15:22Z",
    "type": "smtp",
    "host": "string",
    "port": 25,
    "encryption": "none",
    "auth": { … },
    "_links": [ … ]
  }
]