GET
/
org
/
{org}
/
gvc
/
{gvc}
/
workload
/
{name}
curl --request GET \
  --url https://api.cpln.io/org/{org}/gvc/{gvc}/workload/{name}
{
  "id": "<string>",
  "kind": "<string>",
  "version": 123,
  "description": "<string>",
  "tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ],
  "name": "<string>",
  "gvc": {},
  "spec": {
    "type": "serverless",
    "identityLink": "<string>",
    "containers": [
      {
        "name": "<string>",
        "image": "<string>",
        "workingDir": "<string>",
        "metrics": {
          "port": 123,
          "path": "<string>"
        },
        "port": 123,
        "ports": [
          {
            "protocol": "http",
            "number": 123
          }
        ],
        "memory": "<string>",
        "readinessProbe": {
          "exec": {
            "command": [
              "<string>"
            ]
          },
          "grpc": {
            "port": 123
          },
          "tcpSocket": {
            "port": 123
          },
          "httpGet": {
            "path": "<string>",
            "port": 123,
            "httpHeaders": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ],
            "scheme": "HTTP"
          },
          "initialDelaySeconds": 123,
          "periodSeconds": 123,
          "timeoutSeconds": 123,
          "successThreshold": 123,
          "failureThreshold": 123
        },
        "livenessProbe": {
          "exec": {
            "command": [
              "<string>"
            ]
          },
          "grpc": {
            "port": 123
          },
          "tcpSocket": {
            "port": 123
          },
          "httpGet": {
            "path": "<string>",
            "port": 123,
            "httpHeaders": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ],
            "scheme": "HTTP"
          },
          "initialDelaySeconds": 123,
          "periodSeconds": 123,
          "timeoutSeconds": 123,
          "successThreshold": 123,
          "failureThreshold": 123
        },
        "cpu": "<string>",
        "minCpu": "<string>",
        "minMemory": "<string>",
        "env": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "gpu": {
          "nvidia": {
            "model": {},
            "quantity": 123
          }
        },
        "inheritEnv": true,
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "lifecycle": {
          "postStart": {
            "exec": {
              "command": [
                "<string>"
              ]
            }
          },
          "preStop": {
            "exec": {
              "command": [
                "<string>"
              ]
            }
          }
        },
        "volumes": [
          {
            "uri": "<string>",
            "recoveryPolicy": "retain",
            "path": "<string>"
          }
        ]
      }
    ],
    "firewallConfig": {
      "external": {
        "inboundAllowCIDR": [
          "<string>"
        ],
        "outboundAllowHostname": [
          "<string>"
        ],
        "outboundAllowPort": [
          {
            "protocol": "http",
            "number": 123
          }
        ],
        "outboundAllowCIDR": [
          "<string>"
        ]
      },
      "internal": {
        "inboundAllowType": "none",
        "inboundAllowWorkload": [
          "<string>"
        ]
      }
    },
    "defaultOptions": {},
    "localOptions": [
      {}
    ],
    "job": {
      "schedule": "<string>",
      "concurrencyPolicy": "Forbid",
      "historyLimit": 123,
      "restartPolicy": "OnFailure",
      "activeDeadlineSeconds": 123
    },
    "sidecar": {
      "envoy": {
        "accessLog": [
          {
            "priority": 123,
            "name": "envoy.http_grpc_access_log",
            "typed_config": {
              "@type": {},
              "common_config": {
                "log_name": "<string>",
                "grpc_service": {
                  "envoy_grpc": {
                    "cluster_name": "<string>",
                    "authority": "<string>",
                    "retry_policy": {
                      "retry_back_off": {
                        "base_interval": "<string>",
                        "max_interval": "<string>"
                      },
                      "num_retries": 123
                    }
                  },
                  "google_grpc": {
                    "target_uri": "<string>",
                    "channel_credentials": {
                      "ssl_credentials": {
                        "root_certs": {
                          "filename": "<string>",
                          "inline_bytes": "<any>",
                          "inline_string": "<string>",
                          "environment_variable": "<string>"
                        },
                        "private_key": {
                          "filename": "<string>",
                          "inline_bytes": "<any>",
                          "inline_string": "<string>",
                          "environment_variable": "<string>"
                        },
                        "cert_chain": {
                          "filename": "<string>",
                          "inline_bytes": "<any>",
                          "inline_string": "<string>",
                          "environment_variable": "<string>"
                        }
                      },
                      "google_default": {}
                    },
                    "call_credentials": [
                      {
                        "access_token": "<string>",
                        "google_compute_engine": {},
                        "google_refresh_token": "<string>",
                        "service_account_jwt_access": {
                          "json_key": "<string>",
                          "token_lifetime_seconds": 123
                        },
                        "google_iam": {
                          "authorization_token": "<string>",
                          "authority_selector": "<string>"
                        },
                        "from_plugin": {
                          "name": "<string>",
                          "typed_config": {}
                        },
                        "sts_service": {
                          "token_exchange_service_uri": "<string>",
                          "resource": "<string>",
                          "audience": "<string>",
                          "scope": "<string>",
                          "requested_token_type": "<string>",
                          "subject_token_path": "<string>",
                          "subject_token_type": "<string>",
                          "actor_token_path": "<string>",
                          "actor_token_type": "<string>"
                        }
                      }
                    ],
                    "stat_prefix": "<string>",
                    "credentials_factory_name": "<string>",
                    "config": {}
                  },
                  "timeout": "<string>",
                  "initial_metadata": [
                    {
                      "key": "<string>",
                      "value": "<string>",
                      "raw_value": "<any>"
                    }
                  ]
                },
                "transport_api_version": "AUTO",
                "buffer_flush_interval": "<string>",
                "buffer_size_bytes": 123,
                "filter_state_objects_to_log": [
                  "<string>"
                ],
                "grpc_stream_retry_policy": {
                  "retry_back_off": {
                    "base_interval": "<string>",
                    "max_interval": "<string>"
                  },
                  "num_retries": 123
                }
              },
              "additional_request_headers_to_log": [
                "<string>"
              ],
              "additional_response_headers_to_log": [
                "<string>"
              ],
              "additional_response_trailers_to_log": [
                "<string>"
              ]
            }
          }
        ],
        "clusters": [
          {
            "name": "<string>",
            "transport_socket_matches": {},
            "alt_stat_name": {},
            "type": "STATIC",
            "cluster_type": {},
            "eds_cluster_config": {},
            "connect_timeout": {},
            "per_connection_buffer_limit_bytes": {},
            "lb_policy": {},
            "load_assignment": {
              "cluster_name": "<string>",
              "endpoints": {},
              "policy": {}
            },
            "health_checks": {},
            "max_requests_per_connection": {},
            "circuit_breakers": {},
            "upstream_http_protocol_options": {},
            "common_http_protocol_options": {},
            "http_protocol_options": {},
            "http2_protocol_options": {},
            "typed_extension_protocol_options": {},
            "dns_refresh_rate": {},
            "dns_failure_refresh_rate": {},
            "respect_dns_ttl": {},
            "dns_lookup_family": {},
            "dns_resolvers": {},
            "use_tcp_for_dns_lookups": {},
            "dns_resolution_config": {},
            "typed_dns_resolver_config": {},
            "wait_for_warm_on_init": {},
            "outlier_detection": {},
            "cleanup_interval": {},
            "upstream_bind_config": {},
            "lb_subset_config": {},
            "ring_hash_lb_config": {},
            "maglev_lb_config": {},
            "least_request_lb_config": {},
            "common_lb_config": {},
            "transport_socket": {},
            "metadata": {},
            "protocol_selection": {},
            "upstream_connection_options": {},
            "close_connections_on_host_health_failure": {},
            "ignore_health_on_host_removal": {},
            "filters": {},
            "load_balancing_policy": {},
            "track_timeout_budgets": {},
            "upstream_config": {},
            "track_cluster_stats": {},
            "preconnect_policy": {},
            "connection_pool_per_downstream_connection": {}
          }
        ],
        "excludedExternalAuth": [
          {
            "match": {
              "prefix": "<string>",
              "path": "<string>",
              "safe_regex": {
                "google_re2": {
                  "max_program_size": 123
                },
                "regex": "<string>"
              },
              "path_separated_prefix": "<string>",
              "path_match_policy": {
                "name": "<string>",
                "typed_config": {}
              },
              "case_sensitive": true,
              "runtime_fraction": {
                "default_value": {
                  "numerator": 123,
                  "denominator": 123
                },
                "runtime_key": "<string>"
              },
              "headers": [
                {
                  "name": "<string>",
                  "safe_regex_match": {
                    "google_re2": {
                      "max_program_size": 123
                    },
                    "regex": "<string>"
                  },
                  "range_match": {
                    "start": 123,
                    "end": 123
                  },
                  "present_match": true,
                  "string_match": {
                    "exact": "<string>",
                    "prefix": "<string>",
                    "suffix": "<string>",
                    "safe_regex": {
                      "google_re2": {
                        "max_program_size": 123
                      },
                      "regex": "<string>"
                    },
                    "contains": "<string>",
                    "ignore_case": true
                  },
                  "invert_match": true,
                  "treat_missing_header_as_empty": true
                }
              ],
              "query_parameters": [
                {
                  "name": "<string>",
                  "string_match": {
                    "exact": "<string>",
                    "prefix": "<string>",
                    "suffix": "<string>",
                    "safe_regex": {
                      "google_re2": {
                        "max_program_size": 123
                      },
                      "regex": "<string>"
                    },
                    "contains": "<string>",
                    "ignore_case": true
                  },
                  "present_match": true
                }
              ],
              "grpc": {
                "presented": true,
                "validated": true
              },
              "tls_context": {
                "presented": true,
                "validated": true
              },
              "dynamic_metadata": [
                {
                  "filter": "<string>",
                  "path": [
                    {
                      "key": "<string>"
                    }
                  ],
                  "value": {
                    "null_match": {},
                    "double_match": {
                      "range": {
                        "start": 123,
                        "end": 123
                      },
                      "exact": 123
                    },
                    "string_match": {
                      "exact": "<string>",
                      "prefix": "<string>",
                      "suffix": "<string>",
                      "safe_regex": {
                        "google_re2": {
                          "max_program_size": 123
                        },
                        "regex": "<string>"
                      },
                      "contains": "<string>",
                      "ignore_case": true
                    },
                    "bool_match": true,
                    "present_match": true
                  },
                  "invert": true
                }
              ]
            },
            "port": 123,
            "svcPort": 123
          }
        ],
        "excludedRateLimit": [
          {
            "match": {
              "prefix": "<string>",
              "path": "<string>",
              "safe_regex": {
                "google_re2": {
                  "max_program_size": 123
                },
                "regex": "<string>"
              },
              "path_separated_prefix": "<string>",
              "path_match_policy": {
                "name": "<string>",
                "typed_config": {}
              },
              "case_sensitive": true,
              "runtime_fraction": {
                "default_value": {
                  "numerator": 123,
                  "denominator": 123
                },
                "runtime_key": "<string>"
              },
              "headers": [
                {
                  "name": "<string>",
                  "safe_regex_match": {
                    "google_re2": {
                      "max_program_size": 123
                    },
                    "regex": "<string>"
                  },
                  "range_match": {
                    "start": 123,
                    "end": 123
                  },
                  "present_match": true,
                  "string_match": {
                    "exact": "<string>",
                    "prefix": "<string>",
                    "suffix": "<string>",
                    "safe_regex": {
                      "google_re2": {
                        "max_program_size": 123
                      },
                      "regex": "<string>"
                    },
                    "contains": "<string>",
                    "ignore_case": true
                  },
                  "invert_match": true,
                  "treat_missing_header_as_empty": true
                }
              ],
              "query_parameters": [
                {
                  "name": "<string>",
                  "string_match": {
                    "exact": "<string>",
                    "prefix": "<string>",
                    "suffix": "<string>",
                    "safe_regex": {
                      "google_re2": {
                        "max_program_size": 123
                      },
                      "regex": "<string>"
                    },
                    "contains": "<string>",
                    "ignore_case": true
                  },
                  "present_match": true
                }
              ],
              "grpc": {
                "presented": true,
                "validated": true
              },
              "tls_context": {
                "presented": true,
                "validated": true
              },
              "dynamic_metadata": [
                {
                  "filter": "<string>",
                  "path": [
                    {
                      "key": "<string>"
                    }
                  ],
                  "value": {
                    "null_match": {},
                    "double_match": {
                      "range": {
                        "start": 123,
                        "end": 123
                      },
                      "exact": 123
                    },
                    "string_match": {
                      "exact": "<string>",
                      "prefix": "<string>",
                      "suffix": "<string>",
                      "safe_regex": {
                        "google_re2": {
                          "max_program_size": 123
                        },
                        "regex": "<string>"
                      },
                      "contains": "<string>",
                      "ignore_case": true
                    },
                    "bool_match": true,
                    "present_match": true
                  },
                  "invert": true
                }
              ]
            },
            "port": 123,
            "svcPort": 123
          }
        ],
        "http": [
          {
            "priority": 123,
            "excludedWorkloads": [
              "<string>"
            ],
            "name": "envoy.filters.http.ext_authz",
            "typed_config": {
              "grpc_service": {
                "envoy_grpc": {
                  "cluster_name": "<string>",
                  "authority": "<string>",
                  "retry_policy": {
                    "retry_back_off": {
                      "base_interval": "<string>",
                      "max_interval": "<string>"
                    },
                    "num_retries": 123
                  }
                },
                "google_grpc": {
                  "target_uri": "<string>",
                  "channel_credentials": {
                    "ssl_credentials": {
                      "root_certs": {
                        "filename": "<string>",
                        "inline_bytes": "<any>",
                        "inline_string": "<string>",
                        "environment_variable": "<string>"
                      },
                      "private_key": {
                        "filename": "<string>",
                        "inline_bytes": "<any>",
                        "inline_string": "<string>",
                        "environment_variable": "<string>"
                      },
                      "cert_chain": {
                        "filename": "<string>",
                        "inline_bytes": "<any>",
                        "inline_string": "<string>",
                        "environment_variable": "<string>"
                      }
                    },
                    "google_default": {}
                  },
                  "call_credentials": [
                    {
                      "access_token": "<string>",
                      "google_compute_engine": {},
                      "google_refresh_token": "<string>",
                      "service_account_jwt_access": {
                        "json_key": "<string>",
                        "token_lifetime_seconds": 123
                      },
                      "google_iam": {
                        "authorization_token": "<string>",
                        "authority_selector": "<string>"
                      },
                      "from_plugin": {
                        "name": "<string>",
                        "typed_config": {}
                      },
                      "sts_service": {
                        "token_exchange_service_uri": "<string>",
                        "resource": "<string>",
                        "audience": "<string>",
                        "scope": "<string>",
                        "requested_token_type": "<string>",
                        "subject_token_path": "<string>",
                        "subject_token_type": "<string>",
                        "actor_token_path": "<string>",
                        "actor_token_type": "<string>"
                      }
                    }
                  ],
                  "stat_prefix": "<string>",
                  "credentials_factory_name": "<string>",
                  "config": {}
                },
                "timeout": "<string>",
                "initial_metadata": [
                  {
                    "key": "<string>",
                    "value": "<string>",
                    "raw_value": "<any>"
                  }
                ]
              },
              "http_service": {
                "server_uri": {
                  "uri": "<string>",
                  "cluster": "<string>",
                  "timeout": "<string>"
                },
                "path_prefix": "<string>",
                "authroization_request": {
                  "allowed_headers": {
                    "patterns": [
                      {
                        "exact": "<string>",
                        "prefix": "<string>",
                        "suffix": "<string>",
                        "safe_regex": {
                          "google_re2": {
                            "max_program_size": 123
                          },
                          "regex": "<string>"
                        },
                        "contains": "<string>",
                        "ignore_case": true
                      }
                    ]
                  },
                  "headers_to_add": [
                    {
                      "key": "<string>",
                      "value": "<string>",
                      "raw_value": "<any>"
                    }
                  ]
                },
                "authorization_response": {
                  "allowed_upstream_headers": {
                    "patterns": [
                      {
                        "exact": "<string>",
                        "prefix": "<string>",
                        "suffix": "<string>",
                        "safe_regex": {
                          "google_re2": {
                            "max_program_size": 123
                          },
                          "regex": "<string>"
                        },
                        "contains": "<string>",
                        "ignore_case": true
                      }
                    ]
                  },
                  "allowed_upstream_headers_to_append": {
                    "patterns": [
                      {
                        "exact": "<string>",
                        "prefix": "<string>",
                        "suffix": "<string>",
                        "safe_regex": {
                          "google_re2": {
                            "max_program_size": 123
                          },
                          "regex": "<string>"
                        },
                        "contains": "<string>",
                        "ignore_case": true
                      }
                    ]
                  },
                  "allowed_client_headers": {
                    "patterns": [
                      {
                        "exact": "<string>",
                        "prefix": "<string>",
                        "suffix": "<string>",
                        "safe_regex": {
                          "google_re2": {
                            "max_program_size": 123
                          },
                          "regex": "<string>"
                        },
                        "contains": "<string>",
                        "ignore_case": true
                      }
                    ]
                  },
                  "allowed_client_headers_on_success": {
                    "patterns": [
                      {
                        "exact": "<string>",
                        "prefix": "<string>",
                        "suffix": "<string>",
                        "safe_regex": {
                          "google_re2": {
                            "max_program_size": 123
                          },
                          "regex": "<string>"
                        },
                        "contains": "<string>",
                        "ignore_case": true
                      }
                    ]
                  },
                  "dynamic_metadata_from_headers": {
                    "patterns": [
                      {
                        "exact": "<string>",
                        "prefix": "<string>",
                        "suffix": "<string>",
                        "safe_regex": {
                          "google_re2": {
                            "max_program_size": 123
                          },
                          "regex": "<string>"
                        },
                        "contains": "<string>",
                        "ignore_case": true
                      }
                    ]
                  }
                }
              },
              "failure_mode_allow": true,
              "failure_mode_allow_header_add": true,
              "with_request_body": {
                "max_request_bytes": 123,
                "allow_partial_message": true,
                "pack_as_bytes": true
              },
              "clear_route_cache": true,
              "status_on_error": {
                "code": "Empty"
              },
              "metadata_context_namespaces": [
                "<string>"
              ],
              "typed_metadata_context_namespaces": [
                "<string>"
              ],
              "route_metadata_context_namespaces": [
                "<string>"
              ],
              "route_typed_metadata_context_namespaces": [
                "<string>"
              ],
              "filter_enabled": {
                "numerator": 123,
                "denominator": 123
              },
              "deny_at_disable": {
                "default_value": true,
                "runtime_key": "<string>"
              },
              "include_peer_certificate": true,
              "stat_prefix": "<string>",
              "bootstrap_metadata_labels_key": "<string>",
              "allowed_headers": {
                "patterns": [
                  {
                    "exact": "<string>",
                    "prefix": "<string>",
                    "suffix": "<string>",
                    "safe_regex": {
                      "google_re2": {
                        "max_program_size": 123
                      },
                      "regex": "<string>"
                    },
                    "contains": "<string>",
                    "ignore_case": true
                  }
                ]
              },
              "include_tls_session": true,
              "charge_cluster_response_stats": true,
              "transport_api_version": "AUTO",
              "@type": "type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz"
            }
          }
        ],
        "network": [
          {}
        ],
        "volumes": [
          {
            "uri": "<string>",
            "recoveryPolicy": "retain",
            "path": "<string>"
          }
        ]
      }
    },
    "supportDynamicTags": true,
    "rolloutOptions": {
      "minReadySeconds": 123,
      "maxUnavailableReplicas": "<string>",
      "maxSurgeReplicas": "<string>",
      "scalingPolicy": "OrderedReady"
    },
    "securityOptions": {
      "filesystemGroupId": 123
    }
  },
  "status": {
    "parentId": "<string>",
    "canonicalEndpoint": "<string>",
    "endpoint": "<string>",
    "internalName": "<string>",
    "healthCheck": {
      "active": true,
      "success": true,
      "code": 123,
      "message": "<string>",
      "failures": 123,
      "successes": 123,
      "lastChecked": "2023-11-07T05:31:56Z"
    },
    "currentReplicaCount": 123,
    "resolvedImages": {
      "resolvedForVersion": 123,
      "resolvedAt": "2023-11-07T05:31:56Z",
      "errorMessages": [
        "<string>"
      ],
      "images": [
        {
          "digest": "<string>",
          "manifests": [
            {
              "image": "<string>",
              "mediaType": "<string>",
              "digest": "<string>",
              "platform": {}
            }
          ]
        }
      ]
    }
  }
}

Authorizations

Authorization
string
headerrequired

Service account key can be used as API keys

Path Parameters

org
string
required
gvc
string
required
name
string
required

Response

200 - application/json
id
string
kind
string
version
integer
description
string
tags
object
created
string
lastModified
string
links
object[]
name
string
gvc
object
spec
object
status
object