SocketLabs API

https://docs.socketlabs.com
Admin
SocketLabs API is a programmatic HTTP interface that allows developers to access SocketLabs features...
Tokens:2,358
Snippets:21
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Filtered API Request URL

Source: https://docs.socketlabs.com/

This example demonstrates how to construct a URL to query the SocketLabs API, applying filters for status and active status. The filters are combined using the '&' character.

```url
https://api.socketlabs.com/v1/servers/12345/search/?filters=status=eq:active&isActive=eq:true
```

--------------------------------

### Example Basic Authorization Header

Source: https://docs.socketlabs.com/

An alternative to Bearer authentication, this uses the Basic scheme. Any string can be used as the username, with your API key as the password.

```http
Authorization: Basic YOUR-API-KEY
```

--------------------------------

### Example Bearer Authorization Header

Source: https://docs.socketlabs.com/

Use this header for authenticating calls to the SocketLabs API with the Bearer scheme. Replace YOUR-API-KEY with your actual API key.

```http
Authorization: Bearer YOUR-API-KEY
```

--------------------------------

### API Error Response Example

Source: https://docs.socketlabs.com/

When API calls encounter errors, the response body may contain a single error or a list of errors, each with an 'errorType' and 'message'.

```json
{
    "error" : [
      {
        "errorType": "InvalidDomainFormat",
        "message": "Domain name not formatted correctly."
      }
   ]
}
```

--------------------------------

### Pagination

Source: https://docs.socketlabs.com/

Endpoints that return arrays of results support offset pagination using query parameters.

```APIDOC
## Pagination

Every endpoint that returns an array of results includes offset pagination. Pagination is defined by an order (`sortDirection`), a limit (`pageSize`), and an offset (`pageNumber`) from the start.

### Query parameters

| Name | Type | Description |
|---|---|---|
| pageSize | number | The number of items to return. Default max size (100) if not specified, min size (1). NOTE: Csv file download endpoints have a default max size of (500000) |
| pageNumber | number | The (zero-based) page number of items from the start of the query to skip. A zero-based page number 0 is the start value. |
| sortDirection | `asc`, `dsc` | The direction the array is sorted |
| sortField | string | the property name the array is sorted by. |
| startDate | dateTime | The start date in yyyy-mm-dd HH:MM:SS format |
| endDate | dateTime | The end date in yyyy-mm-dd HH:MM:SS format |
| filters | string | Narrow down the results based on specific search criteria. See the Filters section below for details. |
```

--------------------------------

### API Conventions and Standards

Source: https://docs.socketlabs.com/

Overview of date formats, response structures, and error handling models used across the SocketLabs API.

```APIDOC
## Date Formats

### Description
The API supports three subsets of ISO 8601 date formats. By default, dates are in UTC, but local offsets (K) can be specified.

### Supported Formats
- yyyy-MM-ddTHH:mm:ssK
- yyyy-MM-ddK
- yyyy-MM-dd

## Response Structure

### Description
Standard API responses include a data array and a total count. CSV download endpoints use the Content-Range header and return 206 (Partial Content) or 200 (OK).

### Response Body
- **data** (array) - The array of results
- **total** (number) - The total number of results available

### Response Example
{
  "data": [],
  "total": 123
}

## Error Handling

### Description
Errors return an HTTP error code with a body containing a list of error objects.

### API Error Model
- **message** (string) - Description of the error
- **errorType** (string) - The specific type of error encountered

### Error Example
{
  "error": [
    {
      "errorType": "InvalidDomainFormat",
      "message": "Domain name not formatted correctly."
    }
  ]
}
```

--------------------------------

### Supported Date Formats

Source: https://docs.socketlabs.com/

These date formats are subsets of ISO 8601 and can be used for filtering. Dates are in UTC by default, but local time offsets can be specified.

```plaintext
yyyy-MM-ddTHH:mm:ssK
yyyy-MM-ddK
yyyy-MM-dd
```

--------------------------------

### Filters

Source: https://docs.socketlabs.com/

You can narrow down results by applying filters to the query string. Filters use a specific format: `field=predicate:value`.

```APIDOC
## Filters

Add filters to the query string to narrow down the results based on specific criteria. The format for adding filters is `filters=field=predicate:value`, where `field` is the name of the field in the dataset on which to apply the filter, `predicate` is the type of comparison to perform on the field, and `value` is the value against which the field should be compared.

### Supported Predicates

#### String
| Predicate Key | Description | Example |
|---|---|---|
| `eq` | Is Equal To | `name=eq:test` |
| `neq` | Not Equal To | `name=neq:test` |
| `like` | Contains | `name=like:some` |
| `nlike` | Does Not Contain | `name=nlike:some` |
| `start` | Starts With | `name=start:test` |
| `end` | Ends With | `name=end:ing` |

#### Number
| Predicate Key | Description | Example |
|---|---|---|
| `eq` | Is Equal To | `id=eq:12` |
| `neq` | Not Equal To | `id=neq:12` |
| `gt` | Greater Than | `score=gt:60` |
| `lt` | Less Than | `score=lt:80` |
| `gte` | Before/Greater Than and Equal To | `score=gte:60` |
| `lte` | After/Less Than and Equal To | `score=lte:80` |

#### Date
| Predicate Key | Description | Example |
|---|---|---|
| `eq` | Is Equal To | `created=eq:2022-02-28` |
| `gt` | Before/Greater Than | `created=gt:2022-02-01` |
| `lt` | After/Less Than | `created=lt:2022-03-01` |
| `gte` | Greater Than and Equal To | `created=gte:2022-02-01` |
| `lte` | Less Than and Equal To | `created=lte:2022-03-01` |

#### Boolean
| Predicate Key | Description | Example |
|---|---|---|
| `eq` | Is Equal To | `isActive=eq:true` |
| `neq` | Not Equal To | `isActive=neq:true` |

#### Enum
| Predicate Key | Description | Example |
|---|---|---|
| `eq` | Is Equal To | `status=eq:active` |
| `neq` | Not Equal To | `status=neq:active` |

### Combining Filters

You can combine multiple filters by separating them with an `&`.
Example: `filters=name=start:jo&emailAddress=end:gmail.com`

### Example
```
https://api.socketlabs.com/v1/servers/12345/search/?filters=status=eq:active&isActive=eq:true
```
```

--------------------------------

### Authentication

Source: https://docs.socketlabs.com/

All calls to the SocketLabs API are authenticated using an API key. You can use either Bearer or Basic authentication.

```APIDOC
## Authentication

All calls to the SocketLabs API are authenticated using the API key that you generated. Authenticate your calls to the SocketLabs API using the `Authorization` header with the `Bearer` authentication scheme.

### Example Bearer authorization header:
`Authorization: Bearer YOUR-API-KEY`

If your application or system does not support the `Bearer` authentication scheme, you may also use the `Basic` scheme. If using the `Basic` scheme, you may use any string as the username and then your API key as the password.

### Example Basic authorization header:
`Authorization: Basic YOUR-API-KEY`
```

--------------------------------

### Rate Limiting

Source: https://docs.socketlabs.com/

Details regarding the request frequency limits imposed on the API.

```APIDOC
## Rate Limiting

### Description
Standard requests are limited to 100 requests per 60 seconds. Specific endpoints may have different limits.

### Standard Limit
- 100 requests / 60 seconds

### Endpoint Specific Limits
- **/reports/message**: 30 requests / 60 seconds
```

--------------------------------

### API Response Structure

Source: https://docs.socketlabs.com/

Standard API responses include a 'data' property containing results and a 'total' property for the total number of available results. CSV endpoints also provide a Content-Range header and a 206 status code for partial content.

```json
{
   "data": [
     …
   ],
   "total": 123
}
```
Tokens:
Raw