---
title: "RenderStream"
description: "Documentation and guidance for building tools and integrations with the Disguise platform."
url: https://developer.disguise.one/api/session/renderstream/
---

# RENDERSTREAM API

-   [GET assigners](#get-assigners)
-   [POST failover](#post-failover)
-   [POST failoverpool](#post-failoverpool)
-   [GET layerconfig](#get-layerconfig)
-   [GET layers](#get-layers)
-   [GET layerstatus](#get-layerstatus)
-   [GET pools](#get-pools)
-   [POST restartlayers](#post-restartlayers)
-   [POST startlayers](#post-startlayers)
-   [POST stoplayers](#post-stoplayers)
-   [POST synclayers](#post-synclayers)

## GET assigners

### Summary

Returns the RenderStream assigners list

### URL

GET    /api/session/renderstream/assigners

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "transport": {
        "type": "",
        "format": "",
        "bitDepth": 0
      },
      "alpha": false,
      "overlapPixels": 0,
      "paddingPixels": 0,
      "preferredNetwork": {
        "ip": "",
        "name": ""
      }
    }
  ]
}
```

## POST failover

### Summary

Fail over a single machine

### URL

POST    /api/session/renderstream/failover

### Request

```json
{
  "machine": {
    "uid": "",
    "name": ""
  }
}
```

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}
```

## POST failoverpool

### Summary

Update the current cluster pool and restart the workload

### URL

POST    /api/session/renderstream/failoverpool

### Request

```json
{
  "layer": {
    "uid": "",
    "name": ""
  }
}
```

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}
```

## GET layerconfig

### Summary

Returns config information for the selected layer

### URL

GET    /api/session/renderstream/layerconfig

### Query Params

uid    uint64    

name    string    

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": {
    "framerateFractionDivisor": 0,
    "asset": {
      "uid": "",
      "name": ""
    },
    "pool": {
      "uid": "",
      "name": ""
    },
    "channelMappings": [
      {
        "channel": "",
        "mapping": {
          "uid": "",
          "name": ""
        },
        "assigner": {
          "uid": "",
          "name": ""
        }
      }
    ],
    "defaultAssigner": {
      "uid": "",
      "name": ""
    }
  }
}
```

## GET layers

### Summary

Returns the RenderStream layer list

### URL

GET    /api/session/renderstream/layers

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": ""
    }
  ]
}
```

## GET layerstatus

### Summary

Returns status information for the selected layer

### URL

GET    /api/session/renderstream/layerstatus

### Query Params

uid    uint64    

name    string    

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": {
    "reference": {
      "tNow": 0
    },
    "workload": {
      "uid": "",
      "name": "",
      "instances": [
        {
          "machineUid": "",
          "machineName": "",
          "state": "",
          "healthMessage": "",
          "healthDetails": ""
        }
      ]
    },
    "streams": [
      {
        "uid": "",
        "name": "",
        "sourceMachine": "",
        "receiverMachine": "",
        "status": {
          "subscriptionWanted": false,
          "subscribeSuccessful": false,
          "tLastDropped": 0,
          "tLastError": 0,
          "lastErrorMessage": ""
        },
        "statusString": ""
      }
    ],
    "assetErrors": [
      ""
    ]
  }
}
```

## GET pools

### Summary

Returns the RenderStream pools list

### URL

GET    /api/session/renderstream/pools

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "machines": [
        {
          "uid": "",
          "name": "",
          "preferredSyncAdapter": "",
          "adapters": [
            {
              "name": "",
              "ipAddress": "",
              "subnet": ""
            }
          ]
        }
      ],
      "understudies": [
        {
          "uid": "",
          "name": "",
          "preferredSyncAdapter": "",
          "adapters": [
            {
              "name": "",
              "ipAddress": "",
              "subnet": ""
            }
          ]
        }
      ]
    }
  ]
}
```

## POST restartlayers

### Summary

Restarts a workload for the selected layer

### URL

POST    /api/session/renderstream/restartlayers

### Request

```json
{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}
```

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}
```

## POST startlayers

### Summary

Starts a workload for the selected layer

### URL

POST    /api/session/renderstream/startlayers

### Request

```json
{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}
```

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}
```

## POST stoplayers

### Summary

Stops a workload for the selected layer

### URL

POST    /api/session/renderstream/stoplayers

### Request

```json
{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}
```

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}
```

## POST synclayers

### Summary

Syncs a workload for the selected layer

### URL

POST    /api/session/renderstream/synclayers

### Request

```json
{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}
```

### Response

```json
{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}
```