docs

Creating and running a test

Test authoring
Cloud tests from the CLI
Script editor
Cloud scripting extras
Private load zones
Troubleshooting

Analyzing Results

Overview
Performance Insights
Inspect thresholds
Inspect checks
Inspect HTTP requests
Inspect logs
Compare metrics
Compare tests
Save, share, and delete tests
Export results

Manage

Thresholds
Schedule a test
Send notifications
Environment variables
Usage Reports
Audit Trail

Integrations

Token
Cloud APM
Grafana App
Cloud to Prometheus RW

Project and Team Management

Organizations
Teams
Projects
Members
SAML SSO

Your plan

Manage subscription
Billing
Pricing questions
About data retention

Cloud reference

Test status codes
Cloud IPs
Cloud REST API
Release notes
k6.ioapp.k6.io

No results for “”

Powered byAlgolia

Organizations

suggest edits

Organizations are the top-level structural unit in k6 Cloud. Read about How to manage organizations.

List organizations

Returns a list of organizations associated with the authenticated user along with organization details.

GET https://api.k6.io/v3/organizations

Response
{
  "organizations": [
    {
      "id": 0,
      "name": "string",
      "owner_id": 0,
      "description": "string",
      "billing_address": "string",
      "billing_country": "string",
      "billing_email": "user@example.com",
      "vat_number": "string",
      "created": "2020-08-13T18:28:45Z",
      "updated": "2020-08-13T18:28:45Z",
      "is_default": true
    }
  ]
}

Read organization details

Returns details for the specified organization.

GET https://api.k6.io/v3/organizations/{organization_id}

Path ParameterTypeDescription
organization_idintegerA unique integer value identifying this organization.
Response
{
  "organization": {
    "id": 0,
    "name": "string",
    "owner_id": 0,
    "description": "string",
    "billing_address": "string",
    "billing_country": "string",
    "billing_email": "user@example.com",
    "vat_number": "string",
    "created": "2020-08-13T18:28:45Z",
    "updated": "2020-08-13T18:28:45Z",
    "is_default": true
  }
}

List organization projects

Returns all projects a user is member of in the specified organization.

GET https://api.k6.io/v3/organizations/{organization_id}/projects

Path ParameterTypeDescription
organization_idintegerA unique integer value identifying this organization.
Response
{
  "projects": [
    {
      "id": 47,
      "name": "my Project",
      "description": "project for load testing of my site",
      "organization_id": 1013,
      "created": "2020-08-13T18:28:45Z",
      "updated": "2020-08-13T18:28:45Z",
      "is_default": true
    }
  ]
}
previousCloud REST API