# Cockpit scope

GET //localhost:8080/api/v1/cockpit/scope

Returns workspace, virtual key, and bound entity (agent/member when applicable) for the authenticated virtual key. May return degraded payload if VK metadata cannot be loaded.

Reference: https://api.alephant.io/api-reference/saa-s-api/cockpit/scope

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: saas-openapi
  version: 1.0.0
paths:
  /api/v1/cockpit/scope:
    get:
      operationId: scope
      summary: Cockpit scope
      description: >-
        Returns workspace, virtual key, and bound entity (agent/member when
        applicable) for the authenticated virtual key. May return degraded
        payload if VK metadata cannot be loaded.
      tags:
        - subpackage_cockpit
      parameters:
        - name: Authorization
          in: header
          description: Bearer virtual key token (prefix vk-)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/github_com_alephant_backend-saas-service_internal_service.CockpitScopeResponse
        '401':
          description: Missing or invalid virtual key
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
servers:
  - url: //localhost:8080
components:
  schemas:
    github_com_alephant_backend-saas-service_internal_service.CockpitEntityRef:
      type: object
      properties:
        department:
          type: string
        id:
          type: string
        name:
          type: string
        type:
          type: string
      title: >-
        github_com_alephant_backend-saas-service_internal_service.CockpitEntityRef
    github_com_alephant_backend-saas-service_internal_service.CockpitVKRef:
      type: object
      properties:
        allowed_models:
          type: array
          items:
            type: string
        id:
          type: string
        label:
          type: string
        prefix:
          type: string
        rate_limit_rpm:
          type: integer
        status:
          type: string
      title: github_com_alephant_backend-saas-service_internal_service.CockpitVKRef
    github_com_alephant_backend-saas-service_internal_service.CockpitWorkspaceRef:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      title: >-
        github_com_alephant_backend-saas-service_internal_service.CockpitWorkspaceRef
    github_com_alephant_backend-saas-service_internal_service.CockpitScopeResponse:
      type: object
      properties:
        data_source:
          type: string
        degraded:
          type: boolean
        entity:
          $ref: >-
            #/components/schemas/github_com_alephant_backend-saas-service_internal_service.CockpitEntityRef
        message:
          type: string
        virtual_key:
          $ref: >-
            #/components/schemas/github_com_alephant_backend-saas-service_internal_service.CockpitVKRef
        workspace:
          $ref: >-
            #/components/schemas/github_com_alephant_backend-saas-service_internal_service.CockpitWorkspaceRef
      title: >-
        github_com_alephant_backend-saas-service_internal_service.CockpitScopeResponse

```

## SDK Code Examples

```python
import requests

url = "https://localhost:8080/api/v1/cockpit/scope"

headers = {"Authorization": "Authorization"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://localhost:8080/api/v1/cockpit/scope';
const options = {method: 'GET', headers: {Authorization: 'Authorization'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://localhost:8080/api/v1/cockpit/scope"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Authorization")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:8080/api/v1/cockpit/scope")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Authorization'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://localhost:8080/api/v1/cockpit/scope")
  .header("Authorization", "Authorization")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://localhost:8080/api/v1/cockpit/scope', [
  'headers' => [
    'Authorization' => 'Authorization',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://localhost:8080/api/v1/cockpit/scope");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Authorization");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Authorization"]

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8080/api/v1/cockpit/scope")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```