---
id: service-action-create
title: "Create a service action"
description: "Create a service action"
sidebar_label: "Create a service action"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zYQ/ivEfdoAJWnTJt30LWtaLMPaBo2DFXCNgBZPNluJVPiS1DP034cjJVmynbTpumUd8skWRd4d7567e0gtQVdouJNanQhIwaK5khle8IyG0swgdwgJOD6zkI7hKIzDJAGBNjOyCo8pPA8TGWeNABYFQAIGLz1a94sWC0iX4VEaFJA64zGBTCuHytErXlWFzIItex8siV2CzeZYcvrnpCsQ0taCBCpDpjuJll4rXmKYtqholnVGqhkkUEr1O6qZm0P6OIGSf2qf9g8OElA6aEblS0jHyhfFpF7f2mteItM5c3NkqJx0i132ylvHprRfpdUOlpVbsKiScSWY0o7hpecFc5qRVKgTsBVmMm82eCFFf1Mngny8ZnquTckdpOC9pPdDs86VvPTIpCCbcomG5dr0jGQGK4MWlUPBuGWcnZ+fHEPcHkXgYptBXC3e5JCO78e0LnzRZxsoO46WM3+jAm6tziQnwYPt0b5LtJbPIlza3b2KY6stcmP4AhKQDkvbA5SefsDMbcCuwCsstuGugRQInHp6lirXzQ+5LkL4mpv2p1lljDbkX+54EbMs574gTzcChg5pzGcWr9CQZ4M9u+w4LrOEv/dh6XvouWCbwUPBo3lIYYJws4a1mVon4GSJ1vGy6glSvpyi2RTUTm1TqBUnFStlUUiLmVbCQl0nveIw7kydJMCFkCSOF6c95+e8sLiu7k0I0wpglJFt3Nm1dPM1V0W9FTe8RIcmxLTz+bJONsI/VHfaLewjL+hx864Ihp1Ziscdxb+Nq1hltPAZCjZdrMmVdoTW9cIw1bpArqAHneAoKkCOO29vA2uFSkg1u+jKfjMQgHtRGT0zaC0kYH2WxX85lwVSCci4yrCg/xtpexYUtwCIxu+ys7n2haAqqlVXYJukRcGueOHREkxoPFb9RhCZ2zStUFibnnWPJbWQ6uN96o8BExfTxedT+9yiYSfHrcc9PV7PNWtkDAC20Qy35ZdU1lHwLWzi+dbU7af7RjOivO+a0WDmKtyTroP3J7TBmNTUUba+2bquLzgsvX1O0lc0qe/qq7WyM97Gdf5VDElaXnE3h6RhU+1ugxlD4ka92WLmqZIG46fIDZojT9RqPKHXBm2llY19cv/du1j77gKmb8UN7zExvwNaWvjZP2PhWeFn6xYeeaeJ/mS8KBZshorqOAqWG12y98Fdkak8sOUHtvzAlv+TbLklG9xt80wHdkEUsk7AV+Iu0/+vLHV4xvj2x4q/e5J4YNHfJYuuA/F8uo1evQxuCrsfaApl0zLhAzE4Oj1hUjk00dqv4l0vmkJ8e/WPmf1cC/x8Ifx1NDplcQHLtKACKIIdahZDGTRSzIbibopWxERYFeVFr+RoUNFtpRIs4w5n2sg/u5SNSj4r/GyujUvY3Jdc7Rjkgk+LVhetZKQzCl/cqa0cowt1q5HV9oLK6CspAqnrcBH7zSe3BWxfDYPBuWcVu1Xf7ZpOBOHBAwgfQHi/IAwbc3NNnzIqbUP46USbwl7T3/aW3aG23us+UtBYewz3poAU5s5VNt3b45XcJX5dFdxR39nNdAn90+8ZATFiq38G7txKgkhDmEYXdGESJM2fl20v++2PUfAbAfzt6pvJi0+8rApcfeJYxWnzRAJPcv7TQX74dOfg2eNnO08PDvd3pk/ybGc/+/nwSX54yHN+CLedab5Uwup0MO5ofUu6O2itTO1R4EfkvAEZGvCY3p1mQ1lbQrjJ+/qU5UsN7zjGly7ok4J2Q3VzQkmXQLCJEH+8+2j3UdhrrEeve6ghZAcSqK0ruepF8+YPZ4MEWq7q4S1LGshRDu5VBZehgAQ8L5s86G6wIIG0f73Duw97c8qbdAzL5ZRbPDdFXdPwpUdDVz2TBK64kVReQvCFtPRfbD9i9O3+4W2Tyz+ym2xtj5WKDpWBW0MKkMBHXAyuo2q6bZgjF2iCEfH986hqZ0RSVus32gcdneOKoyzDyt06d9IrKadvzkaUuc23zDKUfTD8mgoVv4626irWLro5pLElFFzNfMyIKJPynA/LxFpZiJcK27yxXMYZI/0RVV13znH0DOEi8i+GwWZc
sidebar_class_name: "post api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Create a service action"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/service/{serviceId}/action"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Create a service action

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"serviceId","required":true}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"title":"Action","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"parameters":{"default":{},"type":"object","description":"Parameters associated with the action"},"results":{"default":{},"type":"object","description":"Results produced by the action"},"isTest":{"type":"boolean","default":false},"status":{"type":"string","enum":["pending_create","pending","in_progress","success","failed","cancelled"],"description":"Status of the action. Should be one of the specified values in the ActionStatus enumeration"},"service_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"link_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"created_by":{"type":"string","description":"User ID of the user who created the action"}},"description":"Object representing instances","type":"object","additionalProperties":false,"required":["specification_id"],"anyOf":[{"required":["service_id"],"not":{"required":["link_id"]}},{"required":["link_id"],"not":{"required":["service_id"]}},{"not":{"required":["service_id","link_id"]}}]}}},"description":"Object representing instances"}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing instances","content":{"application/json":{"schema":{"title":"Action","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Name of the entity. Must be a non-empty string and not equal to null"},"slug":{"type":"string","minLength":1,"maxLength":255,"not":{"enum":[null]},"description":"Slug of the entity. Automatically generated from \"name\""},"specification_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"desired_specification_id":{"anyOf":[{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},{"type":"null"}],"description":"Desired unique identifier for the associated specification"},"messages":{"title":"Message","type":"array","items":{"type":"object","properties":{"level":{"type":"string","enum":["debug","info","information","warn","warning","error","fatal"],"default":"info","description":"Message severity level. Defaults to \"info\""},"message":{"type":"string","description":"The actual message content"},"timestamp":{"type":"number","description":"Timestamp of the message in milliseconds"}},"required":["message"],"additionalProperties":false,"description":"Object representing messages with severity levels"}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"status":{"type":"string","enum":["pending_create","pending","in_progress","success","failed","cancelled"],"description":"Status of the action. Should be one of the specified values in the ActionStatus enumeration"},"parameters":{"type":"object","description":"Parameters associated with the action"},"results":{"type":"object","description":"Results produced by the action"},"service_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"link_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"created_by":{"type":"string","description":"User ID of the user who created the action"}},"description":"Object representing instances","type":"object","additionalProperties":false}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>