NUnullplatform
Service

Create a service specification

Changed on

Create a service specification

post/service_specification

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/service_specification
  • Auth
    HTTP bearer

Request body

visible_toDef2[] required

Array representing visibility settings for the entity. Specifies what/who can see this entity

type'dependency' | 'scope'

Type of the service specification. Should be one of the specified values in the enumeration

dimensionsDef9
assignable_to'any' | 'dimension' | 'scope'

Specifies if the service can be assigned to any entity, only dimensions, or only scopes.

use_default_actionsboolean

Specifies if the service specification should autogenerate its create, update, and delete actions from the attributes schema. When omitted on create, the default is true for every type except scope. An explicitly sent value always wins

use_default_namingboolean

When true, the instance name is optional and generated by nullplatform or taken from the schema's name property. When false, a caller-provided name is required. Defaults to true for new specifications

package_idstring uuid nullable

The package that owns this service specification. Set automatically when a package revision that includes the specification is published; a specification belongs to at most one package. PATCH can point it at another package or clear it with null to release the claim, for example after deleting the package. The change is refused while any instance of the specification is bound to a package revision, current or desired

Example request

{
  "name": "my-service-specification",
  "visible_to": [
    "organization=1:account=1",
    "organization=1:account=2"
  ],
  "dimensions": {
    "environment": {
      "required": true,
      "values": [
        "production",
        "staging"
      ]
    }
  },
  "scopes": {
    "provider": {
      "values": [
        "AWS:SERVERLESS:LAMBDA",
        "AWS:WEB_POOL:EC2INSTANCES",
        "uuid-of-a-specific-scope-specification"
      ]
    }
  },
  "assignable_to": "any",
  "attributes": {
    "schema": {
      "type": "object",
      "properties": {
        "my_string_property": {
          "type": "string"
        },
        "my_number_property": {
          "type": "number",
          "default": 0
        }
      },
      "required": [
        "my_string_property"
      ]
    },
    "values": {}
  }
}

Response

Object representing service specifications

idstring uuid

Unique identifier for the entity represented as a UUID

created_atstring date
updated_atstring date
visible_toDef2[]

Array representing visibility settings for the entity. Specifies what/who can see this entity

type'dependency' | 'scope'

Type of the service specification. Should be one of the specified values in the enumeration

dimensionsDef9
assignable_to'any' | 'dimension' | 'scope'

Specifies if the service can be assigned to any entity, only dimensions, or only scopes.

use_default_actionsboolean

Specifies if the service specification should autogenerate its create, update, and delete actions from the attributes schema. When omitted on create, the default is true for every type except scope

use_default_namingboolean

When true, the instance name is optional and generated by nullplatform or taken from the schema's name property. When false, a caller-provided name is required. Defaults to true for new specifications

package_idstring uuid nullable

The package that owns this service specification. Set automatically when a package revision that includes the specification is published; a specification belongs to at most one package. PATCH can point it at another package or clear it with null to release the claim, for example after deleting the package. The change is refused while any instance of the specification is bound to a package revision, current or desired

Example response

{
  "name": "my-service-specification",
  "visible_to": [
    "organization=1:account=1",
    "organization=1:account=2"
  ],
  "dimensions": {
    "environment": {
      "required": true,
      "values": [
        "production",
        "staging"
      ]
    }
  },
  "scopes": {
    "provider": {
      "values": [
        "AWS:SERVERLESS:LAMBDA",
        "AWS:WEB_POOL:EC2INSTANCES",
        "uuid-of-a-specific-scope-specification"
      ]
    }
  },
  "assignable_to": "any",
  "attributes": {
    "schema": {
      "type": "object",
      "properties": {
        "my_string_property": {
          "type": "string"
        },
        "my_number_property": {
          "type": "number",
          "default": 0
        }
      },
      "required": [
        "my_string_property"
      ]
    },
    "values": {}
  }
}

Changes

  • 43b3c1ecdfd8Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status