Sprites API Documentation

Network Policy

Get Network Policy

Get the current network policy configuration.

GET /sprites/{name}/policy/network

Response Body

application/json

rules* NetworkPolicyRule[]

List of network policy rules

domain? string

Domain pattern (e.g., *.github.com)

action? string

allow or deny

include? string

Include rules from preset

Response Codes

200

Success

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X GET \
  "https://api.sprites.dev/v1/sprites/{name}/policy/network" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

token := os.Getenv("SPRITE_TOKEN")
spriteName := os.Getenv("SPRITE_NAME")

client := sprites.New(token)
sprite := client.Sprite(spriteName)

policy, err := sprite.GetNetworkPolicy(context.Background())
if err != nil {
	log.Fatal(err)
}

out, _ := json.MarshalIndent(policy, "", "  ")
fmt.Println(string(out))

import { SpritesClient } from '@fly/sprites';

const token = process.env.SPRITE_TOKEN!;
const spriteName = process.env.SPRITE_NAME!;

const client = new SpritesClient(token);
const sprite = client.sprite(spriteName);

const policy = await sprite.getNetworkPolicy();

console.log(JSON.stringify(policy, null, 2));

import json
import os

from sprites import SpritesClient

token = os.environ["SPRITE_TOKEN"]
sprite_name = os.environ["SPRITE_NAME"]

client = SpritesClient(token)
sprite = client.sprite(sprite_name)

policy = sprite.get_network_policy()

result = {
    "rules": [
        {"domain": rule.domain, "action": rule.action}
        for rule in policy.rules
    ]
}

print(json.dumps(result, indent=2))

200 Response

{
  "rules": [
    {
      "action": "allow",
      "domain": "github.com"
    },
    {
      "action": "allow",
      "domain": "*.npmjs.org"
    },
    {
      "action": "deny",
      "domain": "*"
    }
  ]
}

{
  "rules": [
    {
      "domain": "api.github.com",
      "action": "allow"
    },
    {
      "domain": "*.npmjs.org",
      "action": "allow"
    }
  ]
}

{
  "rules": [
    {
      "domain": "api.github.com",
      "action": "allow"
    },
    {
      "domain": "*.npmjs.org",
      "action": "allow"
    }
  ]
}

Network Policy

Set Network Policy

Update the network policy configuration.

POST /sprites/{name}/policy/network

Request Body

application/json

rules* NetworkPolicyRule[]

List of network policy rules

domain? string

Domain pattern (e.g., *.github.com)

action? string

allow or deny

include? string

Include rules from preset

Response Body

application/json

Response Codes

200

Success

400

Bad Request - Invalid request body

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X POST \
  "https://api.sprites.dev/v1/sprites/{name}/policy/network" \
  -H "Authorization: Bearer $SPRITES_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rules":[{"action":"allow","domain":"github.com"},{"action":"allow","domain":"*.npmjs.org"}]}'

token := os.Getenv("SPRITE_TOKEN")
spriteName := os.Getenv("SPRITE_NAME")

client := sprites.New(token)
sprite := client.Sprite(spriteName)

policy := &sprites.NetworkPolicy{
	Rules: []sprites.NetworkPolicyRule{
		{Domain: "api.github.com", Action: "allow"},
		{Domain: "*.npmjs.org", Action: "allow"},
	},
}

err := sprite.UpdateNetworkPolicy(context.Background(), policy)
if err != nil {
	log.Fatal(err)
}

fmt.Println("Network policy updated")

import { SpritesClient } from '@fly/sprites';

const token = process.env.SPRITE_TOKEN!;
const spriteName = process.env.SPRITE_NAME!;

const client = new SpritesClient(token);
const sprite = client.sprite(spriteName);

await sprite.updateNetworkPolicy({
  rules: [
    { domain: 'api.github.com', action: 'allow' },
    { domain: '*.npmjs.org', action: 'allow' },
  ],
});

console.log('Network policy updated');

import os

from sprites import NetworkPolicy, PolicyRule, SpritesClient

token = os.environ["SPRITE_TOKEN"]
sprite_name = os.environ["SPRITE_NAME"]

client = SpritesClient(token)
sprite = client.sprite(sprite_name)

policy = NetworkPolicy(
    rules=[
        PolicyRule(domain="api.github.com", action="allow"),
        PolicyRule(domain="*.npmjs.org", action="allow"),
    ]
)

sprite.update_network_policy(policy)

print("Network policy updated")

200 Response

{
  "rules": [
    {
      "action": "allow",
      "domain": "github.com"
    }
  ]
}

Network policy updated

Network policy updated

Network Policy

Get Privileges Policy

Get the current privileges policy configuration (capability and device restrictions).

GET /sprites/{name}/policy/privileges

Response Body

application/json

Response Codes

200

Success

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X GET \
  "https://api.sprites.dev/v1/sprites/{name}/policy/privileges" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

200 Response

Network Policy

Set Privileges Policy

Update the privileges policy configuration to restrict capabilities or devices.

POST /sprites/{name}/policy/privileges

Response Body

application/json

Response Codes

200

Success

400

Bad Request - Invalid request body

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X POST \
  "https://api.sprites.dev/v1/sprites/{name}/policy/privileges" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

200 Response

Network Policy

Delete Privileges Policy

Remove privileges policy to revert to default (unrestricted) behavior.

DELETE /sprites/{name}/policy/privileges

Response Body

application/json

Response Codes

200

Success

400

Bad Request - Invalid request body

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X DELETE \
  "https://api.sprites.dev/v1/sprites/{name}/policy/privileges" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

200 Response

Network Policy

Get Resources Policy

Get the current resources policy configuration (memory limits).

GET /sprites/{name}/policy/resources

Response Body

application/json

Response Codes

200

Success

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X GET \
  "https://api.sprites.dev/v1/sprites/{name}/policy/resources" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

200 Response

Network Policy

Set Resources Policy

Update the resources policy configuration to set memory limits.

POST /sprites/{name}/policy/resources

Response Body

application/json

Response Codes

200

Success

400

Bad Request - Invalid request body

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X POST \
  "https://api.sprites.dev/v1/sprites/{name}/policy/resources" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

200 Response

Network Policy

Delete Resources Policy

Remove resources policy to revert to default behavior.

DELETE /sprites/{name}/policy/resources

Response Body

application/json

Response Codes

200

Success

400

Bad Request - Invalid request body

404

Not Found - Resource not found

500

Internal Server Error

bash

curl -X DELETE \
  "https://api.sprites.dev/v1/sprites/{name}/policy/resources" \
  -H "Authorization: Bearer $SPRITES_TOKEN"

200 Response