v1

latestOpenAPI 3.0.3BSD-3-Clause License2026-07-17201927.6 KB
rpaas

Get a summary info about an instance

get/resources/{instance}/info

Path parameters

instancestring required

Instance name

Response

OK

namestring
descriptionstring
teamstring
tagsstring[]
planstring
flavorsstring[]
replicasnumber

Example response

{
  "name": "my-instance",
  "description": "Awesome description about my-instance.",
  "team": "team-one",
  "tags": [
    "tag1",
    "tag2"
  ],
  "plan": "small",
  "flavors": [
    "coffe",
    "milk",
    "chocolate"
  ],
  "replicas": 42,
  "autoscale": {
    "minReplicas": 3,
    "maxReplicas": 100,
    "cpu": 95,
    "memory": 80,
    "rps": 100,
    "schedules": [
      {
        "minReplicas": 10,
        "start": "00 20 * * * 1-5",
        "end": "00 00 * * * 1-5",
        "timezone": "America/Sao_Paulo"
      }
    ],
    "behavior": {
      "scaleDown": {
        "stabilizationWindowSeconds": 300,
        "unitsPolicyValue": 3,
        "percentPolicyValue": 30
      }
    }
  },
  "pods": [
    {
      "name": "my-instance-abcdef-12345",
      "ip": "172.16.10.10",
      "host": "10.10.10.10",
      "ports": [
        {
          "name": "http",
          "hostPort": 20001,
          "containerPort": 20001,
          "protocol": "TCP",
          "hostIP": "0.0.0.0"
        }
      ],
      "createdAt": "2020-08-20T00:00:00Z"
    }
  ],
  "certificates": [
    {
      "name": "default",
      "dnsNames": [
        "my-instance.example.com",
        "my-instance.test"
      ],
      "publicKeyAlgorithm": "RSA",
      "publicKeyBitSize": 4096,
      "validFrom": "2020-08-20T00:00:00Z",
      "validUntil": "2020-08-20T00:00:00Z"
    }
  ],
  "blocks": [
    {
      "block_name": "root",
      "content": "# Some custom Nginx conf snippet which will be injected into root/main context.\n# See more at https://nginx.org/en/docs/ngx_core_module.html\nload_module /path/to/my/module.so;"
    }
  ],
  "routes": [
    {
      "path": "/checkout/cart",
      "destination": "checkout.apps.tsuru.example.com",
      "https_only": true
    }
  ]
}