4 - description: OSM NB API
5 url: 'https://osm.etsi.org/nbapi/v1.0.0'
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
14 title: OSM NB API featuring ETSI NFV SOL005
16 email: OSM_TECH@list.etsi.org
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
32 - name: 'NS Performance Management'
33 description: Management operations related to Performance Mangement of NS instances
34 - name: 'Physical Data Units (PDU)'
35 description: Management operations of PDUs
36 - name: 'Authentication'
37 description: Authentication operations
39 description: Management operations of users, projects and roles
40 - name: 'Infrastructure'
41 description: Management operations of VIM, VIM accounts, WIM and SDN controllers
42 - name: 'Repositories'
43 description: Management operations of repositories
45 description: Management operations of Administration items
53 '/nsd/v1/ns_descriptors':
57 summary: Query information about multiple NS descriptor resources
58 description: Query information about multiple NS descriptor resources
66 $ref: '#/components/schemas/ArrayOfNsdInfo'
69 $ref: '#/components/schemas/ArrayOfNsdInfo'
71 $ref: '#/components/responses/BadRequest'
73 $ref: '#/components/responses/Unauthorized'
75 $ref: '#/components/responses/Forbidden'
77 $ref: '#/components/responses/NotFound'
79 $ref: '#/components/responses/MethodNotAllowed'
81 $ref: '#/components/responses/NotAcceptable'
83 $ref: '#/components/responses/Conflict'
85 $ref: '#/components/responses/UnprocessableEntity'
87 $ref: '#/components/responses/InternalServerError'
89 $ref: '#/components/responses/ServiceUnavailable'
91 $ref: '#/components/responses/UnexpectedError'
93 $ref: '#/components/responses/UnexpectedError'
97 summary: Create a new NS descriptor resource
98 description: Create a new NS descriptor resource
101 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
113 $ref: '#/components/schemas/ObjectId'
116 $ref: '#/components/schemas/ObjectId'
118 $ref: '#/components/responses/BadRequest'
120 $ref: '#/components/responses/Unauthorized'
122 $ref: '#/components/responses/Forbidden'
124 $ref: '#/components/responses/NotFound'
126 $ref: '#/components/responses/MethodNotAllowed'
128 $ref: '#/components/responses/NotAcceptable'
130 $ref: '#/components/responses/Conflict'
132 $ref: '#/components/responses/UnprocessableEntity'
134 $ref: '#/components/responses/InternalServerError'
136 $ref: '#/components/responses/ServiceUnavailable'
138 $ref: '#/components/responses/UnexpectedError'
140 $ref: '#/components/responses/UnexpectedError'
141 '/nsd/v1/ns_descriptors/{nsdInfoId}':
146 description: NSD Info ID
152 summary: Read information about an individual NS descriptor resource
153 description: Read information about an individual NS descriptor resource
161 $ref: '#/components/schemas/NsdInfo'
164 $ref: '#/components/schemas/NsdInfo'
166 $ref: '#/components/responses/BadRequest'
168 $ref: '#/components/responses/Unauthorized'
170 $ref: '#/components/responses/Forbidden'
172 $ref: '#/components/responses/NotFound'
174 $ref: '#/components/responses/MethodNotAllowed'
176 $ref: '#/components/responses/NotAcceptable'
178 $ref: '#/components/responses/Conflict'
180 $ref: '#/components/responses/UnprocessableEntity'
182 $ref: '#/components/responses/InternalServerError'
184 $ref: '#/components/responses/ServiceUnavailable'
186 $ref: '#/components/responses/UnexpectedError'
188 $ref: '#/components/responses/UnexpectedError'
192 summary: Delete an individual NS descriptor resource
193 description: Delete an individual NS descriptor resource
194 operationId: deleteNSD
197 description: No Content
199 $ref: '#/components/responses/BadRequest'
201 $ref: '#/components/responses/Unauthorized'
203 $ref: '#/components/responses/Forbidden'
205 $ref: '#/components/responses/NotFound'
207 $ref: '#/components/responses/MethodNotAllowed'
209 $ref: '#/components/responses/NotAcceptable'
211 $ref: '#/components/responses/Conflict'
213 $ref: '#/components/responses/UnprocessableEntity'
215 $ref: '#/components/responses/InternalServerError'
217 $ref: '#/components/responses/ServiceUnavailable'
219 $ref: '#/components/responses/UnexpectedError'
221 $ref: '#/components/responses/UnexpectedError'
225 summary: Modify the data of an individual NS descriptor resource
226 description: Modify the data of an individual NS descriptor resource
227 operationId: updateNSD
229 $ref: '#/components/requestBodies/NsdInfoModifications'
232 description: No Content
234 $ref: '#/components/responses/BadRequest'
236 $ref: '#/components/responses/Unauthorized'
238 $ref: '#/components/responses/Forbidden'
240 $ref: '#/components/responses/NotFound'
242 $ref: '#/components/responses/MethodNotAllowed'
244 $ref: '#/components/responses/NotAcceptable'
246 $ref: '#/components/responses/Conflict'
248 $ref: '#/components/responses/UnprocessableEntity'
250 $ref: '#/components/responses/InternalServerError'
252 $ref: '#/components/responses/ServiceUnavailable'
254 $ref: '#/components/responses/UnexpectedError'
256 $ref: '#/components/responses/UnexpectedError'
257 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
262 description: NSD Info ID
268 summary: Fetch the content of a NSD
269 description: Fetch the content of a NSD
270 operationId: getNSDcontent
277 $ref: '#/components/schemas/NsPackage'
279 description: Partial Content
287 $ref: '#/components/schemas/NsPackage'
289 $ref: '#/components/responses/BadRequest'
291 $ref: '#/components/responses/Unauthorized'
293 $ref: '#/components/responses/Forbidden'
295 $ref: '#/components/responses/NotFound'
297 $ref: '#/components/responses/MethodNotAllowed'
299 $ref: '#/components/responses/NotAcceptable'
301 $ref: '#/components/responses/Conflict'
303 $ref: '#/components/responses/UnprocessableEntity'
305 $ref: '#/components/responses/InternalServerError'
307 $ref: '#/components/responses/ServiceUnavailable'
309 $ref: '#/components/responses/UnexpectedError'
311 $ref: '#/components/responses/UnexpectedError'
315 summary: Upload the content of a NSD
316 description: Upload the content of a NSD
317 operationId: updateNSDcontent
319 $ref: '#/components/requestBodies/NsPackage'
322 description: Accepted
324 description: No Content
326 $ref: '#/components/responses/BadRequest'
328 $ref: '#/components/responses/Unauthorized'
330 $ref: '#/components/responses/Forbidden'
332 $ref: '#/components/responses/NotFound'
334 $ref: '#/components/responses/MethodNotAllowed'
336 $ref: '#/components/responses/NotAcceptable'
338 $ref: '#/components/responses/Conflict'
340 $ref: '#/components/responses/UnprocessableEntity'
342 $ref: '#/components/responses/InternalServerError'
344 $ref: '#/components/responses/ServiceUnavailable'
346 $ref: '#/components/responses/UnexpectedError'
348 $ref: '#/components/responses/UnexpectedError'
349 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
354 description: NS Package ID
360 description: Artifact Path
366 summary: Fetch individual NS package artifact
367 description: Fetch individual NS package artifact
368 operationId: getNsPkgArtifact
373 application/octet-stream:
378 description: Partial Content
384 application/octet-stream:
389 $ref: '#/components/responses/BadRequest'
391 $ref: '#/components/responses/Unauthorized'
393 $ref: '#/components/responses/Forbidden'
395 $ref: '#/components/responses/NotFound'
397 $ref: '#/components/responses/MethodNotAllowed'
399 $ref: '#/components/responses/NotAcceptable'
401 $ref: '#/components/responses/Conflict'
403 $ref: '#/components/responses/UnprocessableEntity'
405 $ref: '#/components/responses/InternalServerError'
407 $ref: '#/components/responses/ServiceUnavailable'
409 $ref: '#/components/responses/UnexpectedError'
411 $ref: '#/components/responses/UnexpectedError'
412 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
417 description: NS Package ID
423 summary: Read NSD of an on-boarded NS package
424 description: Read NSD of an on-boarded NS package
425 operationId: getNsPkgNsd
432 $ref: '#/components/schemas/NsDescriptor'
434 $ref: '#/components/responses/BadRequest'
436 $ref: '#/components/responses/Unauthorized'
438 $ref: '#/components/responses/Forbidden'
440 $ref: '#/components/responses/NotFound'
442 $ref: '#/components/responses/MethodNotAllowed'
444 $ref: '#/components/responses/NotAcceptable'
446 $ref: '#/components/responses/Conflict'
448 $ref: '#/components/responses/UnprocessableEntity'
450 $ref: '#/components/responses/InternalServerError'
452 $ref: '#/components/responses/ServiceUnavailable'
454 $ref: '#/components/responses/UnexpectedError'
456 $ref: '#/components/responses/UnexpectedError'
457 '/nsd/v1/ns_descriptors_content':
461 summary: Upload a NS package by providing the content of the NS package
462 description: Upload a NS package by providing the content of the NS package
463 operationId: uploadNsPkgsContent
468 $ref: '#/components/schemas/NsPackage'
480 $ref: '#/components/schemas/ObjectId'
483 $ref: '#/components/schemas/ObjectId'
485 description: Accepted
487 description: No Content
489 $ref: '#/components/responses/BadRequest'
491 $ref: '#/components/responses/Unauthorized'
493 $ref: '#/components/responses/Forbidden'
495 $ref: '#/components/responses/NotFound'
497 $ref: '#/components/responses/MethodNotAllowed'
499 $ref: '#/components/responses/NotAcceptable'
501 $ref: '#/components/responses/Conflict'
503 $ref: '#/components/responses/UnprocessableEntity'
505 $ref: '#/components/responses/InternalServerError'
507 $ref: '#/components/responses/ServiceUnavailable'
509 $ref: '#/components/responses/UnexpectedError'
511 $ref: '#/components/responses/UnexpectedError'
515 summary: Query information about multiple NS package resources
516 description: Query information about multiple NS package resources
517 operationId: getNsPkgsContent
524 $ref: '#/components/schemas/ArrayOfNsdInfo'
527 $ref: '#/components/schemas/ArrayOfNsdInfo'
529 description: Partial Content
535 application/octet-stream:
540 $ref: '#/components/responses/BadRequest'
542 $ref: '#/components/responses/Unauthorized'
544 $ref: '#/components/responses/Forbidden'
546 $ref: '#/components/responses/NotFound'
548 $ref: '#/components/responses/MethodNotAllowed'
550 $ref: '#/components/responses/NotAcceptable'
552 $ref: '#/components/responses/Conflict'
554 $ref: '#/components/responses/UnprocessableEntity'
556 $ref: '#/components/responses/InternalServerError'
558 $ref: '#/components/responses/ServiceUnavailable'
560 $ref: '#/components/responses/UnexpectedError'
562 $ref: '#/components/responses/UnexpectedError'
563 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
568 description: NS Package ID
574 summary: Read information about an individual NS package resource
575 description: Read information about an individual NS package resource
576 operationId: getNsPkgsIdContent
583 $ref: '#/components/schemas/NsdInfo'
586 $ref: '#/components/schemas/NsdInfo'
588 $ref: '#/components/responses/BadRequest'
590 $ref: '#/components/responses/Unauthorized'
592 $ref: '#/components/responses/Forbidden'
594 $ref: '#/components/responses/NotFound'
596 $ref: '#/components/responses/MethodNotAllowed'
598 $ref: '#/components/responses/NotAcceptable'
600 $ref: '#/components/responses/Conflict'
602 $ref: '#/components/responses/UnprocessableEntity'
604 $ref: '#/components/responses/InternalServerError'
606 $ref: '#/components/responses/ServiceUnavailable'
608 $ref: '#/components/responses/UnexpectedError'
610 $ref: '#/components/responses/UnexpectedError'
614 summary: Modify an individual NS package resource
615 description: Modify an individual NS package resource
616 operationId: updateNsPkgsIdContent
618 $ref: '#/components/requestBodies/NsdInfoModifications'
621 description: No Content
623 $ref: '#/components/responses/BadRequest'
625 $ref: '#/components/responses/Unauthorized'
627 $ref: '#/components/responses/Forbidden'
629 $ref: '#/components/responses/NotFound'
631 $ref: '#/components/responses/MethodNotAllowed'
633 $ref: '#/components/responses/NotAcceptable'
635 $ref: '#/components/responses/Conflict'
637 $ref: '#/components/responses/UnprocessableEntity'
639 $ref: '#/components/responses/InternalServerError'
641 $ref: '#/components/responses/ServiceUnavailable'
643 $ref: '#/components/responses/UnexpectedError'
645 $ref: '#/components/responses/UnexpectedError'
649 summary: Delete an individual NS package resource
650 description: Delete an individual NS package resource
651 operationId: deleteNSPkgsIdContent
654 description: No Content
656 $ref: '#/components/responses/BadRequest'
658 $ref: '#/components/responses/Unauthorized'
660 $ref: '#/components/responses/Forbidden'
662 $ref: '#/components/responses/NotFound'
664 $ref: '#/components/responses/MethodNotAllowed'
666 $ref: '#/components/responses/NotAcceptable'
668 $ref: '#/components/responses/Conflict'
670 $ref: '#/components/responses/UnprocessableEntity'
672 $ref: '#/components/responses/InternalServerError'
674 $ref: '#/components/responses/ServiceUnavailable'
676 $ref: '#/components/responses/UnexpectedError'
678 $ref: '#/components/responses/UnexpectedError'
682 '/vnfpkgm/v1/vnf_packages':
686 summary: Query information about multiple VNF package resources
687 description: Query information about multiple VNF package resources
688 operationId: getVnfPkgs
695 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
698 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
700 $ref: '#/components/responses/BadRequest'
702 $ref: '#/components/responses/Unauthorized'
704 $ref: '#/components/responses/Forbidden'
706 $ref: '#/components/responses/NotFound'
708 $ref: '#/components/responses/MethodNotAllowed'
710 $ref: '#/components/responses/NotAcceptable'
712 $ref: '#/components/responses/Conflict'
714 $ref: '#/components/responses/UnprocessableEntity'
716 $ref: '#/components/responses/InternalServerError'
718 $ref: '#/components/responses/ServiceUnavailable'
720 $ref: '#/components/responses/UnexpectedError'
722 $ref: '#/components/responses/UnexpectedError'
726 summary: Create a new VNF package resource
727 description: Create a new VNF package resource
728 operationId: addVnfPkg
730 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
742 $ref: '#/components/schemas/ObjectId'
745 $ref: '#/components/schemas/ObjectId'
747 $ref: '#/components/responses/BadRequest'
749 $ref: '#/components/responses/Unauthorized'
751 $ref: '#/components/responses/Forbidden'
753 $ref: '#/components/responses/NotFound'
755 $ref: '#/components/responses/MethodNotAllowed'
757 $ref: '#/components/responses/NotAcceptable'
759 $ref: '#/components/responses/Conflict'
761 $ref: '#/components/responses/UnprocessableEntity'
763 $ref: '#/components/responses/InternalServerError'
765 $ref: '#/components/responses/ServiceUnavailable'
767 $ref: '#/components/responses/UnexpectedError'
769 $ref: '#/components/responses/UnexpectedError'
770 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
775 description: VNF Package ID
781 summary: Read information about an individual VNF package resource
782 description: Read information about an individual VNF package resource
783 operationId: getVnfPkg
790 $ref: '#/components/schemas/VnfPkgInfo'
793 $ref: '#/components/schemas/VnfPkgInfo'
795 $ref: '#/components/responses/BadRequest'
797 $ref: '#/components/responses/Unauthorized'
799 $ref: '#/components/responses/Forbidden'
801 $ref: '#/components/responses/NotFound'
803 $ref: '#/components/responses/MethodNotAllowed'
805 $ref: '#/components/responses/NotAcceptable'
807 $ref: '#/components/responses/Conflict'
809 $ref: '#/components/responses/UnprocessableEntity'
811 $ref: '#/components/responses/InternalServerError'
813 $ref: '#/components/responses/ServiceUnavailable'
815 $ref: '#/components/responses/UnexpectedError'
817 $ref: '#/components/responses/UnexpectedError'
821 summary: Delete an individual VNF package resource
822 description: Delete an individual VNF package resource
823 operationId: deleteVnfPkg
826 description: No Content
828 $ref: '#/components/responses/BadRequest'
830 $ref: '#/components/responses/Unauthorized'
832 $ref: '#/components/responses/Forbidden'
834 $ref: '#/components/responses/NotFound'
836 $ref: '#/components/responses/MethodNotAllowed'
838 $ref: '#/components/responses/NotAcceptable'
840 $ref: '#/components/responses/Conflict'
842 $ref: '#/components/responses/UnprocessableEntity'
844 $ref: '#/components/responses/InternalServerError'
846 $ref: '#/components/responses/ServiceUnavailable'
848 $ref: '#/components/responses/UnexpectedError'
850 $ref: '#/components/responses/UnexpectedError'
854 summary: Modify an individual VNF package resource
855 description: Modify an individual VNF package resource
856 operationId: updateVnfPkg
858 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
861 description: No Content
863 $ref: '#/components/responses/BadRequest'
865 $ref: '#/components/responses/Unauthorized'
867 $ref: '#/components/responses/Forbidden'
869 $ref: '#/components/responses/NotFound'
871 $ref: '#/components/responses/MethodNotAllowed'
873 $ref: '#/components/responses/NotAcceptable'
875 $ref: '#/components/responses/Conflict'
877 $ref: '#/components/responses/UnprocessableEntity'
879 $ref: '#/components/responses/InternalServerError'
881 $ref: '#/components/responses/ServiceUnavailable'
883 $ref: '#/components/responses/UnexpectedError'
885 $ref: '#/components/responses/UnexpectedError'
886 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
891 description: VNF Package ID
897 summary: Read VNFD of an on-boarded VNF package
898 description: Read VNFD of an on-boarded VNF package
899 operationId: getVnfPkgVnfd
906 $ref: '#/components/schemas/VnfDescriptor'
908 $ref: '#/components/responses/BadRequest'
910 $ref: '#/components/responses/Unauthorized'
912 $ref: '#/components/responses/Forbidden'
914 $ref: '#/components/responses/NotFound'
916 $ref: '#/components/responses/MethodNotAllowed'
918 $ref: '#/components/responses/NotAcceptable'
920 $ref: '#/components/responses/Conflict'
922 $ref: '#/components/responses/UnprocessableEntity'
924 $ref: '#/components/responses/InternalServerError'
926 $ref: '#/components/responses/ServiceUnavailable'
928 $ref: '#/components/responses/UnexpectedError'
930 $ref: '#/components/responses/UnexpectedError'
931 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
936 description: VNF Package ID
942 summary: Fetch an on-boarded VNF package
943 description: Fetch an on-boarded VNF package
944 operationId: getVnfPkgContent
951 $ref: '#/components/schemas/VnfPackage'
953 description: Partial Content
961 $ref: '#/components/schemas/VnfPackage'
963 $ref: '#/components/responses/BadRequest'
965 $ref: '#/components/responses/Unauthorized'
967 $ref: '#/components/responses/Forbidden'
969 $ref: '#/components/responses/NotFound'
971 $ref: '#/components/responses/MethodNotAllowed'
973 $ref: '#/components/responses/NotAcceptable'
975 $ref: '#/components/responses/Conflict'
977 $ref: '#/components/responses/UnprocessableEntity'
979 $ref: '#/components/responses/InternalServerError'
981 $ref: '#/components/responses/ServiceUnavailable'
983 $ref: '#/components/responses/UnexpectedError'
985 $ref: '#/components/responses/UnexpectedError'
989 summary: Upload a VNF package by providing the content of the VNF package
990 description: Upload a VNF package by providing the content of the VNF package
991 operationId: uploadVnfPkgContent
996 $ref: '#/components/schemas/VnfPackage'
999 description: Accepted
1001 description: No Content
1003 $ref: '#/components/responses/BadRequest'
1005 $ref: '#/components/responses/Unauthorized'
1007 $ref: '#/components/responses/Forbidden'
1009 $ref: '#/components/responses/NotFound'
1011 $ref: '#/components/responses/MethodNotAllowed'
1013 $ref: '#/components/responses/NotAcceptable'
1015 $ref: '#/components/responses/Conflict'
1017 $ref: '#/components/responses/UnprocessableEntity'
1019 $ref: '#/components/responses/InternalServerError'
1021 $ref: '#/components/responses/ServiceUnavailable'
1023 $ref: '#/components/responses/UnexpectedError'
1025 $ref: '#/components/responses/UnexpectedError'
1026 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1031 description: VNF Package ID
1034 - name: artifactPath
1037 description: Artifact Path
1043 summary: Fetch individual VNF package artifact
1044 description: Fetch individual VNF package artifact
1045 operationId: getVnfPkgArtifact
1050 application/octet-stream:
1055 description: Partial Content
1061 application/octet-stream:
1066 $ref: '#/components/responses/BadRequest'
1068 $ref: '#/components/responses/Unauthorized'
1070 $ref: '#/components/responses/Forbidden'
1072 $ref: '#/components/responses/NotFound'
1074 $ref: '#/components/responses/MethodNotAllowed'
1076 $ref: '#/components/responses/NotAcceptable'
1078 $ref: '#/components/responses/Conflict'
1080 $ref: '#/components/responses/UnprocessableEntity'
1082 $ref: '#/components/responses/InternalServerError'
1084 $ref: '#/components/responses/ServiceUnavailable'
1086 $ref: '#/components/responses/UnexpectedError'
1088 $ref: '#/components/responses/UnexpectedError'
1089 '/vnfpkgm/v1/vnf_packages_content':
1093 summary: Upload a VNF package by providing the content of the VNF package
1094 description: Upload a VNF package by providing the content of the VNF package
1095 operationId: uploadVnfPkgsContent
1100 $ref: '#/components/schemas/VnfPackage'
1103 description: Created
1112 $ref: '#/components/schemas/ObjectId'
1115 $ref: '#/components/schemas/ObjectId'
1117 description: Accepted
1119 description: No Content
1121 $ref: '#/components/responses/BadRequest'
1123 $ref: '#/components/responses/Unauthorized'
1125 $ref: '#/components/responses/Forbidden'
1127 $ref: '#/components/responses/NotFound'
1129 $ref: '#/components/responses/MethodNotAllowed'
1131 $ref: '#/components/responses/NotAcceptable'
1133 $ref: '#/components/responses/Conflict'
1135 $ref: '#/components/responses/UnprocessableEntity'
1137 $ref: '#/components/responses/InternalServerError'
1139 $ref: '#/components/responses/ServiceUnavailable'
1141 $ref: '#/components/responses/UnexpectedError'
1143 $ref: '#/components/responses/UnexpectedError'
1147 summary: Query information about multiple VNF package resources
1148 description: Query information about multiple VNF package resources
1149 operationId: getVnfPkgsContent
1156 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1159 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1161 description: Partial Content
1167 application/octet-stream:
1172 $ref: '#/components/responses/BadRequest'
1174 $ref: '#/components/responses/Unauthorized'
1176 $ref: '#/components/responses/Forbidden'
1178 $ref: '#/components/responses/NotFound'
1180 $ref: '#/components/responses/MethodNotAllowed'
1182 $ref: '#/components/responses/NotAcceptable'
1184 $ref: '#/components/responses/Conflict'
1186 $ref: '#/components/responses/UnprocessableEntity'
1188 $ref: '#/components/responses/InternalServerError'
1190 $ref: '#/components/responses/ServiceUnavailable'
1192 $ref: '#/components/responses/UnexpectedError'
1194 $ref: '#/components/responses/UnexpectedError'
1195 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1197 - name: packageContentId
1200 description: VNF Package Content ID
1206 summary: Read information about an individual VNF package resource
1207 description: Read information about an individual VNF package resource
1208 operationId: getVnfPkgsIdContent
1215 $ref: '#/components/schemas/VnfPkgInfo'
1218 $ref: '#/components/schemas/VnfPkgInfo'
1220 $ref: '#/components/responses/BadRequest'
1222 $ref: '#/components/responses/Unauthorized'
1224 $ref: '#/components/responses/Forbidden'
1226 $ref: '#/components/responses/NotFound'
1228 $ref: '#/components/responses/MethodNotAllowed'
1230 $ref: '#/components/responses/NotAcceptable'
1232 $ref: '#/components/responses/Conflict'
1234 $ref: '#/components/responses/UnprocessableEntity'
1236 $ref: '#/components/responses/InternalServerError'
1238 $ref: '#/components/responses/ServiceUnavailable'
1240 $ref: '#/components/responses/UnexpectedError'
1242 $ref: '#/components/responses/UnexpectedError'
1246 summary: Modify an individual VNF package resource
1247 description: Modify an individual VNF package resource
1248 operationId: updateVnfPkgsIdContent
1250 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1253 description: No Content
1255 $ref: '#/components/responses/BadRequest'
1257 $ref: '#/components/responses/Unauthorized'
1259 $ref: '#/components/responses/Forbidden'
1261 $ref: '#/components/responses/NotFound'
1263 $ref: '#/components/responses/MethodNotAllowed'
1265 $ref: '#/components/responses/NotAcceptable'
1267 $ref: '#/components/responses/Conflict'
1269 $ref: '#/components/responses/UnprocessableEntity'
1271 $ref: '#/components/responses/InternalServerError'
1273 $ref: '#/components/responses/ServiceUnavailable'
1275 $ref: '#/components/responses/UnexpectedError'
1277 $ref: '#/components/responses/UnexpectedError'
1281 summary: Delete an individual VNF package resource
1282 description: Delete an individual VNF package resource
1283 operationId: deleteVnfPkgsIdContent
1286 description: No Content
1288 $ref: '#/components/responses/BadRequest'
1290 $ref: '#/components/responses/Unauthorized'
1292 $ref: '#/components/responses/Forbidden'
1294 $ref: '#/components/responses/NotFound'
1296 $ref: '#/components/responses/MethodNotAllowed'
1298 $ref: '#/components/responses/NotAcceptable'
1300 $ref: '#/components/responses/Conflict'
1302 $ref: '#/components/responses/UnprocessableEntity'
1304 $ref: '#/components/responses/InternalServerError'
1306 $ref: '#/components/responses/ServiceUnavailable'
1308 $ref: '#/components/responses/UnexpectedError'
1310 $ref: '#/components/responses/UnexpectedError'
1313 # BEGIN NS Instances
1314 '/nslcm/v1/ns_instances':
1318 summary: Query information about multiple NS instances
1319 description: Query information about multiple NS isntances
1320 operationId: getNSinstances
1327 $ref: '#/components/schemas/ArrayOfNsInstance'
1330 $ref: '#/components/schemas/ArrayOfNsInstance'
1332 $ref: '#/components/responses/BadRequest'
1334 $ref: '#/components/responses/Unauthorized'
1336 $ref: '#/components/responses/Forbidden'
1338 $ref: '#/components/responses/NotFound'
1340 $ref: '#/components/responses/MethodNotAllowed'
1342 $ref: '#/components/responses/NotAcceptable'
1344 $ref: '#/components/responses/Conflict'
1346 $ref: '#/components/responses/UnprocessableEntity'
1348 $ref: '#/components/responses/InternalServerError'
1350 $ref: '#/components/responses/ServiceUnavailable'
1352 $ref: '#/components/responses/UnexpectedError'
1354 $ref: '#/components/responses/UnexpectedError'
1358 summary: Create a new NS instance resource
1359 description: Create a new NS instance resource
1360 operationId: addNSinstance
1362 $ref: '#/components/requestBodies/InstantiateNsRequest'
1365 description: Created
1374 $ref: '#/components/schemas/ObjectId'
1377 $ref: '#/components/schemas/ObjectId'
1379 $ref: '#/components/responses/BadRequest'
1381 $ref: '#/components/responses/Unauthorized'
1383 $ref: '#/components/responses/Forbidden'
1385 $ref: '#/components/responses/NotFound'
1387 $ref: '#/components/responses/MethodNotAllowed'
1389 $ref: '#/components/responses/NotAcceptable'
1391 $ref: '#/components/responses/Conflict'
1393 $ref: '#/components/responses/UnprocessableEntity'
1395 $ref: '#/components/responses/InternalServerError'
1397 $ref: '#/components/responses/ServiceUnavailable'
1399 $ref: '#/components/responses/UnexpectedError'
1401 $ref: '#/components/responses/UnexpectedError'
1402 '/nslcm/v1/ns_instances/{nsInstanceId}':
1404 - name: nsInstanceId
1407 description: NS Instance ID
1410 - name: vcaStatusRefresh
1413 description: Set to true if vca status needs to be refreshed.
1419 summary: Read an individual NS instance resource
1420 description: Read an individual NS instance resource
1421 operationId: getNSinstance
1428 $ref: '#/components/schemas/NsInstance'
1431 $ref: '#/components/schemas/NsInstance'
1433 $ref: '#/components/responses/BadRequest'
1435 $ref: '#/components/responses/Unauthorized'
1437 $ref: '#/components/responses/Forbidden'
1439 $ref: '#/components/responses/NotFound'
1441 $ref: '#/components/responses/MethodNotAllowed'
1443 $ref: '#/components/responses/NotAcceptable'
1445 $ref: '#/components/responses/Conflict'
1447 $ref: '#/components/responses/UnprocessableEntity'
1449 $ref: '#/components/responses/InternalServerError'
1451 $ref: '#/components/responses/ServiceUnavailable'
1453 $ref: '#/components/responses/UnexpectedError'
1455 $ref: '#/components/responses/UnexpectedError'
1459 summary: Delete an individual NS instance resource
1460 description: Delete an individual NS instance resource
1461 operationId: deleteNSinstance
1464 description: No Content
1466 $ref: '#/components/responses/BadRequest'
1468 $ref: '#/components/responses/Unauthorized'
1470 $ref: '#/components/responses/Forbidden'
1472 $ref: '#/components/responses/NotFound'
1474 $ref: '#/components/responses/MethodNotAllowed'
1476 $ref: '#/components/responses/NotAcceptable'
1478 $ref: '#/components/responses/Conflict'
1480 $ref: '#/components/responses/UnprocessableEntity'
1482 $ref: '#/components/responses/InternalServerError'
1484 $ref: '#/components/responses/ServiceUnavailable'
1486 $ref: '#/components/responses/UnexpectedError'
1488 $ref: '#/components/responses/UnexpectedError'
1489 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1491 - name: nsInstanceId
1494 description: NS Instance ID
1500 summary: Instantiate a NS
1502 Instantiate a NS. The precondition is that the NS instance must have
1503 been created and must be in NOT_INSTANTIATED state. As a result of the
1504 success of this operation, the NFVO creates a "NS Lifecycle Operation
1505 Occurrence" resource for the request, and the NS instance state becomes
1507 operationId: instantiateNSinstance
1509 $ref: '#/components/requestBodies/InstantiateNsRequest'
1512 description: Accepted
1516 It must point to the new "NS Lifecycle Operation Occurrence"
1517 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1524 $ref: '#/components/schemas/ObjectId'
1527 $ref: '#/components/schemas/ObjectId'
1529 $ref: '#/components/responses/BadRequest'
1531 $ref: '#/components/responses/Unauthorized'
1533 $ref: '#/components/responses/Forbidden'
1535 $ref: '#/components/responses/NotFound'
1537 $ref: '#/components/responses/MethodNotAllowed'
1539 $ref: '#/components/responses/NotAcceptable'
1541 $ref: '#/components/responses/Conflict'
1543 $ref: '#/components/responses/UnprocessableEntity'
1545 $ref: '#/components/responses/InternalServerError'
1547 $ref: '#/components/responses/ServiceUnavailable'
1549 $ref: '#/components/responses/UnexpectedError'
1551 $ref: '#/components/responses/UnexpectedError'
1552 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1554 - name: nsInstanceId
1557 description: NS Instance ID
1563 summary: Scale a NS instance
1565 Scale a NS instance. The precondition is that the NS instance must have
1566 been created and must be in INSTANTIATED state. As a result of the
1567 success of this operation, the NFVO creates a "NS Lifecycle Operation
1568 Occurrence" resource for the request, and the NS instance state remains
1570 operationId: scaleNSinstance
1572 $ref: '#/components/requestBodies/ScaleNsRequest'
1575 description: Accepted
1579 It must point to the new "NS Lifecycle Operation Occurrence"
1580 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1585 $ref: '#/components/responses/BadRequest'
1587 $ref: '#/components/responses/Unauthorized'
1589 $ref: '#/components/responses/Forbidden'
1591 $ref: '#/components/responses/NotFound'
1593 $ref: '#/components/responses/MethodNotAllowed'
1595 $ref: '#/components/responses/NotAcceptable'
1597 $ref: '#/components/responses/Conflict'
1599 $ref: '#/components/responses/UnprocessableEntity'
1601 $ref: '#/components/responses/InternalServerError'
1603 $ref: '#/components/responses/ServiceUnavailable'
1605 $ref: '#/components/responses/UnexpectedError'
1607 $ref: '#/components/responses/UnexpectedError'
1608 '/nslcm/v1/ns_instances/{nsInstanceId}/heal':
1610 - name: nsInstanceId
1613 description: NS Instance ID
1619 summary: Heal a NS instance
1621 Heal a NS instance. The precondition is that the NS instance must have
1622 been created and must be in INSTANTIATED state. As a result of the
1623 success of this operation, the NFVO creates a "NS Lifecycle Operation
1624 Occurrence" resource for the request, and the NS instance state remains
1626 operationId: healNSinstance
1628 $ref: '#/components/requestBodies/HealNsRequest'
1631 description: Accepted
1635 It must point to the new "NS Lifecycle Operation Occurrence"
1636 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1641 $ref: '#/components/responses/BadRequest'
1643 $ref: '#/components/responses/Unauthorized'
1645 $ref: '#/components/responses/Forbidden'
1647 $ref: '#/components/responses/NotFound'
1649 $ref: '#/components/responses/MethodNotAllowed'
1651 $ref: '#/components/responses/NotAcceptable'
1653 $ref: '#/components/responses/Conflict'
1655 $ref: '#/components/responses/UnprocessableEntity'
1657 $ref: '#/components/responses/InternalServerError'
1659 $ref: '#/components/responses/ServiceUnavailable'
1661 $ref: '#/components/responses/UnexpectedError'
1663 $ref: '#/components/responses/UnexpectedError'
1664 '/nslcm/v1/ns_instances/{nsInstanceId}/migrate':
1666 - name: nsInstanceId
1669 description: NS Instance ID
1675 summary: Migrate VNFs in a NS instance
1677 Migrate the VNFs and VDUs in a NS instance. The precondition is
1678 that the NS instance must have been created and must be in
1679 INSTANTIATED state. As a result of the success of this operation,
1680 the NFVO creates a "NS Lifecycle Operation Occurrence" resource
1681 for the request, and the NS instance state remains INSTANTIATED.
1682 operationId: migrateNSinstance
1684 $ref: '#/components/requestBodies/NSinstanceMigrateRequest'
1687 description: Accepted
1691 It must point to the new "NS Lifecycle Operation Occurrence"
1692 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1697 $ref: '#/components/responses/BadRequest'
1699 $ref: '#/components/responses/Unauthorized'
1701 $ref: '#/components/responses/Forbidden'
1703 $ref: '#/components/responses/NotFound'
1705 $ref: '#/components/responses/MethodNotAllowed'
1707 $ref: '#/components/responses/NotAcceptable'
1709 $ref: '#/components/responses/Conflict'
1711 $ref: '#/components/responses/UnprocessableEntity'
1713 $ref: '#/components/responses/InternalServerError'
1715 $ref: '#/components/responses/ServiceUnavailable'
1717 $ref: '#/components/responses/UnexpectedError'
1719 $ref: '#/components/responses/UnexpectedError'
1720 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1722 - name: nsInstanceId
1725 description: NS Instance ID
1731 summary: Terminate a NS instance
1733 Terminate a NS instance. The precondition is that the NS instance must have
1734 been created and must be in INSTANTIATED state. As a result of the
1735 success of this operation, the NFVO creates a "NS Lifecycle Operation
1736 Occurrence" resource for the request, and the NS instance state becomes
1738 operationId: terminateNSinstance
1740 # Request data is not required
1741 $ref: '#/components/requestBodies/TerminateNsRequest'
1744 description: Accepted
1748 It must point to the new "NS Lifecycle Operation Occurrence"
1749 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1756 $ref: '#/components/schemas/ObjectId'
1759 $ref: '#/components/schemas/ObjectId'
1761 $ref: '#/components/responses/BadRequest'
1763 $ref: '#/components/responses/Unauthorized'
1765 $ref: '#/components/responses/Forbidden'
1767 $ref: '#/components/responses/NotFound'
1769 $ref: '#/components/responses/MethodNotAllowed'
1771 $ref: '#/components/responses/NotAcceptable'
1773 $ref: '#/components/responses/Conflict'
1775 $ref: '#/components/responses/UnprocessableEntity'
1777 $ref: '#/components/responses/InternalServerError'
1779 $ref: '#/components/responses/ServiceUnavailable'
1781 $ref: '#/components/responses/UnexpectedError'
1783 $ref: '#/components/responses/UnexpectedError'
1784 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1786 - name: nsInstanceId
1789 description: NS Instance ID
1795 summary: Execute an action on a NS instance
1797 Execute an action on a NS instance.
1798 The NS instance must have been created and must be in INSTANTIATED state.
1799 operationId: actionOnNSinstance
1804 $ref: '#/components/schemas/NSinstanceActionRequest'
1807 $ref: '#/components/schemas/NSinstanceActionRequest'
1810 description: Accepted
1814 It must point to the new "NS Lifecycle Operation Occurrence"
1815 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1822 $ref: '#/components/schemas/ObjectId'
1825 $ref: '#/components/schemas/ObjectId'
1827 $ref: '#/components/responses/BadRequest'
1829 $ref: '#/components/responses/Unauthorized'
1831 $ref: '#/components/responses/Forbidden'
1833 $ref: '#/components/responses/NotFound'
1835 $ref: '#/components/responses/MethodNotAllowed'
1837 $ref: '#/components/responses/NotAcceptable'
1839 $ref: '#/components/responses/Conflict'
1841 $ref: '#/components/responses/UnprocessableEntity'
1843 $ref: '#/components/responses/InternalServerError'
1845 $ref: '#/components/responses/ServiceUnavailable'
1847 $ref: '#/components/responses/UnexpectedError'
1849 $ref: '#/components/responses/UnexpectedError'
1850 '/nslcm/v1/ns_instances/{nsInstanceId}/update':
1852 - name: nsInstanceId
1855 description: NS Instance ID
1861 summary: Update a NS instance
1863 Update a NS instance. The precondition is that the NS instance must have
1864 been created and must be in INSTANTIATED state. As a result of the
1865 success of this operation, the NFVO creates a "NS Lifecycle Operation
1866 Occurrence" resource for the request, and the NS instance state remains
1868 operationId: updateNSinstance
1870 $ref: '#/components/requestBodies/UpdateNsRequest'
1873 description: Accepted
1877 It must point to the new "NS Lifecycle Operation Occurrence"
1878 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1883 $ref: '#/components/responses/BadRequest'
1885 $ref: '#/components/responses/Unauthorized'
1887 $ref: '#/components/responses/Forbidden'
1889 $ref: '#/components/responses/NotFound'
1891 $ref: '#/components/responses/MethodNotAllowed'
1893 $ref: '#/components/responses/NotAcceptable'
1895 $ref: '#/components/responses/Conflict'
1897 $ref: '#/components/responses/UnprocessableEntity'
1899 $ref: '#/components/responses/InternalServerError'
1901 $ref: '#/components/responses/ServiceUnavailable'
1903 $ref: '#/components/responses/UnexpectedError'
1905 $ref: '#/components/responses/UnexpectedError'
1906 '/nslcm/v1/ns_instances/{nsInstanceId}/verticalscale':
1908 - name: nsInstanceId
1911 description: NS Instance ID
1917 summary: Vertical scale a NS instance
1919 Execute an verticalscale on a NS instance.
1920 The NS instance must have been created and must be in INSTANTIATED state.
1921 operationId: verticalscaleNSinstance
1923 $ref: '#/components/requestBodies/VerticalscaleNsRequest'
1926 description: Accepted
1930 It must point to the new "NS Lifecycle Operation Occurrence"
1931 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1936 $ref: '#/components/responses/BadRequest'
1938 $ref: '#/components/responses/Unauthorized'
1940 $ref: '#/components/responses/Forbidden'
1942 $ref: '#/components/responses/NotFound'
1944 $ref: '#/components/responses/MethodNotAllowed'
1946 $ref: '#/components/responses/NotAcceptable'
1948 $ref: '#/components/responses/Conflict'
1950 $ref: '#/components/responses/UnprocessableEntity'
1952 $ref: '#/components/responses/InternalServerError'
1954 $ref: '#/components/responses/ServiceUnavailable'
1956 $ref: '#/components/responses/UnexpectedError'
1958 $ref: '#/components/responses/UnexpectedError'
1959 '/nslcm/v1/ns_instances_content':
1963 summary: Query information about multiple NS instances
1964 description: Query information about multiple NS isntances
1965 operationId: getNSinstancesContent
1972 $ref: '#/components/schemas/ArrayOfNsInstance'
1975 $ref: '#/components/schemas/ArrayOfNsInstance'
1977 $ref: '#/components/responses/BadRequest'
1979 $ref: '#/components/responses/Unauthorized'
1981 $ref: '#/components/responses/Forbidden'
1983 $ref: '#/components/responses/NotFound'
1985 $ref: '#/components/responses/MethodNotAllowed'
1987 $ref: '#/components/responses/NotAcceptable'
1989 $ref: '#/components/responses/Conflict'
1991 $ref: '#/components/responses/UnprocessableEntity'
1993 $ref: '#/components/responses/InternalServerError'
1995 $ref: '#/components/responses/ServiceUnavailable'
1997 $ref: '#/components/responses/UnexpectedError'
1999 $ref: '#/components/responses/UnexpectedError'
2003 summary: Create a new NS instance
2004 description: Create a new NS instance
2005 operationId: createNSinstanceContent
2007 $ref: '#/components/requestBodies/InstantiateNsRequest'
2010 description: Created
2019 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2022 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
2024 $ref: '#/components/responses/BadRequest'
2026 $ref: '#/components/responses/Unauthorized'
2028 $ref: '#/components/responses/Forbidden'
2030 $ref: '#/components/responses/NotFound'
2032 $ref: '#/components/responses/MethodNotAllowed'
2034 $ref: '#/components/responses/NotAcceptable'
2036 $ref: '#/components/responses/Conflict'
2038 $ref: '#/components/responses/UnprocessableEntity'
2040 $ref: '#/components/responses/InternalServerError'
2042 $ref: '#/components/responses/ServiceUnavailable'
2044 $ref: '#/components/responses/UnexpectedError'
2046 $ref: '#/components/responses/UnexpectedError'
2047 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
2049 - name: nsInstanceContentId
2052 description: NS Instance Content ID
2058 summary: Read an individual NS instance resource
2059 description: Read an individual NS instance resource
2060 operationId: getNSinstanceContent
2067 $ref: '#/components/schemas/NsInstance'
2070 $ref: '#/components/schemas/NsInstance'
2072 $ref: '#/components/responses/BadRequest'
2074 $ref: '#/components/responses/Unauthorized'
2076 $ref: '#/components/responses/Forbidden'
2078 $ref: '#/components/responses/NotFound'
2080 $ref: '#/components/responses/MethodNotAllowed'
2082 $ref: '#/components/responses/NotAcceptable'
2084 $ref: '#/components/responses/Conflict'
2086 $ref: '#/components/responses/UnprocessableEntity'
2088 $ref: '#/components/responses/InternalServerError'
2090 $ref: '#/components/responses/ServiceUnavailable'
2092 $ref: '#/components/responses/UnexpectedError'
2094 $ref: '#/components/responses/UnexpectedError'
2098 summary: Delete an individual NS instance resource
2099 description: Delete an individual NS instance resource
2100 operationId: deleteNSinstanceContent
2103 description: Accepted
2107 $ref: '#/components/schemas/ObjectId'
2110 $ref: '#/components/schemas/ObjectId'
2112 description: No Content
2114 $ref: '#/components/responses/BadRequest'
2116 $ref: '#/components/responses/Unauthorized'
2118 $ref: '#/components/responses/Forbidden'
2120 $ref: '#/components/responses/NotFound'
2122 $ref: '#/components/responses/MethodNotAllowed'
2124 $ref: '#/components/responses/NotAcceptable'
2126 $ref: '#/components/responses/Conflict'
2128 $ref: '#/components/responses/UnprocessableEntity'
2130 $ref: '#/components/responses/InternalServerError'
2132 $ref: '#/components/responses/ServiceUnavailable'
2134 $ref: '#/components/responses/UnexpectedError'
2136 $ref: '#/components/responses/UnexpectedError'
2137 '/nslcm/v1/ns_lcm_op_occs':
2141 summary: Query information about multiple NS LCM Operation Occurrences
2142 description: Query information about multiple NS LCM Operation Occurrences
2143 operationId: getNSLCMOpOccs
2150 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2153 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2155 $ref: '#/components/responses/BadRequest'
2157 $ref: '#/components/responses/Unauthorized'
2159 $ref: '#/components/responses/Forbidden'
2161 $ref: '#/components/responses/NotFound'
2163 $ref: '#/components/responses/MethodNotAllowed'
2165 $ref: '#/components/responses/NotAcceptable'
2167 $ref: '#/components/responses/Conflict'
2169 $ref: '#/components/responses/UnprocessableEntity'
2171 $ref: '#/components/responses/InternalServerError'
2173 $ref: '#/components/responses/ServiceUnavailable'
2175 $ref: '#/components/responses/UnexpectedError'
2177 $ref: '#/components/responses/UnexpectedError'
2178 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2180 - name: nsLcmOpOccId
2183 description: NS LCM Operation Occurrence ID
2189 summary: Query information about an individual NS LCM Operation Occurrence
2190 description: Query information about an individual NS LCM Operation Occurrence
2191 operationId: getNSLCMOpOcc
2198 $ref: '#/components/schemas/NsLcmOpOcc'
2201 $ref: '#/components/schemas/NsLcmOpOcc'
2203 $ref: '#/components/responses/BadRequest'
2205 $ref: '#/components/responses/Unauthorized'
2207 $ref: '#/components/responses/Forbidden'
2209 $ref: '#/components/responses/NotFound'
2211 $ref: '#/components/responses/MethodNotAllowed'
2213 $ref: '#/components/responses/NotAcceptable'
2215 $ref: '#/components/responses/Conflict'
2217 $ref: '#/components/responses/UnprocessableEntity'
2219 $ref: '#/components/responses/InternalServerError'
2221 $ref: '#/components/responses/ServiceUnavailable'
2223 $ref: '#/components/responses/UnexpectedError'
2225 $ref: '#/components/responses/UnexpectedError'
2226 '/nslcm/v1/vnf_instances':
2230 summary: Query information about multiple VNF Instances
2231 description: Query information about multiple VNF Instances
2232 operationId: getVnfInstances
2239 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2242 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2244 $ref: '#/components/responses/BadRequest'
2246 $ref: '#/components/responses/Unauthorized'
2248 $ref: '#/components/responses/Forbidden'
2250 $ref: '#/components/responses/NotFound'
2252 $ref: '#/components/responses/MethodNotAllowed'
2254 $ref: '#/components/responses/NotAcceptable'
2256 $ref: '#/components/responses/Conflict'
2258 $ref: '#/components/responses/UnprocessableEntity'
2260 $ref: '#/components/responses/InternalServerError'
2262 $ref: '#/components/responses/ServiceUnavailable'
2264 $ref: '#/components/responses/UnexpectedError'
2266 $ref: '#/components/responses/UnexpectedError'
2267 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2269 - name: vnfInstanceId
2272 description: VNF Instance ID
2278 summary: Query information about an individual VNF Instance
2279 description: Query information about an individual VNF Instance
2280 operationId: getVnfInstance
2287 $ref: '#/components/schemas/VnfInstanceInfo'
2290 $ref: '#/components/schemas/VnfInstanceInfo'
2292 $ref: '#/components/responses/BadRequest'
2294 $ref: '#/components/responses/Unauthorized'
2296 $ref: '#/components/responses/Forbidden'
2298 $ref: '#/components/responses/NotFound'
2300 $ref: '#/components/responses/MethodNotAllowed'
2302 $ref: '#/components/responses/NotAcceptable'
2304 $ref: '#/components/responses/Conflict'
2306 $ref: '#/components/responses/UnprocessableEntity'
2308 $ref: '#/components/responses/InternalServerError'
2310 $ref: '#/components/responses/ServiceUnavailable'
2312 $ref: '#/components/responses/UnexpectedError'
2314 $ref: '#/components/responses/UnexpectedError'
2315 '/nslcm/v1/subscriptions':
2319 summary: Query information about multiple NS instance subscription
2320 description: Query information about multiple NS instance subscription
2321 operationId: getNsSubcriptions
2328 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2331 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2333 $ref: '#/components/responses/BadRequest'
2335 $ref: '#/components/responses/Unauthorized'
2337 $ref: '#/components/responses/Forbidden'
2339 $ref: '#/components/responses/NotFound'
2341 $ref: '#/components/responses/MethodNotAllowed'
2343 $ref: '#/components/responses/NotAcceptable'
2345 $ref: '#/components/responses/Conflict'
2347 $ref: '#/components/responses/UnprocessableEntity'
2349 $ref: '#/components/responses/InternalServerError'
2351 $ref: '#/components/responses/ServiceUnavailable'
2353 $ref: '#/components/responses/UnexpectedError'
2355 $ref: '#/components/responses/UnexpectedError'
2359 summary: Create a new subscription for the Network service
2360 description: Create a new subscription for the Network service
2361 operationId: addNsSubcriptions
2363 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2366 description: Created
2374 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2377 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2379 $ref: '#/components/responses/BadRequest'
2381 $ref: '#/components/responses/Unauthorized'
2383 $ref: '#/components/responses/Forbidden'
2385 $ref: '#/components/responses/NotFound'
2387 $ref: '#/components/responses/MethodNotAllowed'
2389 $ref: '#/components/responses/NotAcceptable'
2391 $ref: '#/components/responses/Conflict'
2393 $ref: '#/components/responses/UnprocessableEntity'
2395 $ref: '#/components/responses/InternalServerError'
2397 $ref: '#/components/responses/ServiceUnavailable'
2399 $ref: '#/components/responses/UnexpectedError'
2401 $ref: '#/components/responses/UnexpectedError'
2402 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2404 - name: nsSubscriptionsId
2407 description: Network Service Subscription ID
2413 summary: Read information about an individual Network Service Subscription
2414 description: Read information about an individual Network Service Subscription
2415 operationId: getNsSubcriptionId
2422 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2425 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2427 $ref: '#/components/responses/BadRequest'
2429 $ref: '#/components/responses/Unauthorized'
2431 $ref: '#/components/responses/Forbidden'
2433 $ref: '#/components/responses/NotFound'
2435 $ref: '#/components/responses/MethodNotAllowed'
2437 $ref: '#/components/responses/NotAcceptable'
2439 $ref: '#/components/responses/Conflict'
2441 $ref: '#/components/responses/UnprocessableEntity'
2443 $ref: '#/components/responses/InternalServerError'
2445 $ref: '#/components/responses/ServiceUnavailable'
2447 $ref: '#/components/responses/UnexpectedError'
2449 $ref: '#/components/responses/UnexpectedError'
2453 summary: Delete an individual Network Service Subscription
2454 description: Delete an individual Network Service Subscription
2455 operationId: deleteNsSubcriptionId
2458 description: No Content
2460 $ref: '#/components/responses/BadRequest'
2462 $ref: '#/components/responses/Unauthorized'
2464 $ref: '#/components/responses/Forbidden'
2466 $ref: '#/components/responses/NotFound'
2468 $ref: '#/components/responses/MethodNotAllowed'
2470 $ref: '#/components/responses/NotAcceptable'
2472 $ref: '#/components/responses/Conflict'
2474 $ref: '#/components/responses/UnprocessableEntity'
2476 $ref: '#/components/responses/InternalServerError'
2478 $ref: '#/components/responses/ServiceUnavailable'
2480 $ref: '#/components/responses/UnexpectedError'
2482 $ref: '#/components/responses/UnexpectedError'
2490 summary: Query information about multiple alarms
2491 description: Query information about multiple alarms
2492 operationId: getAlarms
2499 $ref: '#/components/schemas/ArrayOfAlarm'
2502 $ref: '#/components/schemas/ArrayOfAlarm'
2504 $ref: '#/components/responses/BadRequest'
2506 $ref: '#/components/responses/Unauthorized'
2508 $ref: '#/components/responses/Forbidden'
2510 $ref: '#/components/responses/NotFound'
2512 $ref: '#/components/responses/MethodNotAllowed'
2514 $ref: '#/components/responses/NotAcceptable'
2516 $ref: '#/components/responses/Conflict'
2518 $ref: '#/components/responses/UnprocessableEntity'
2520 $ref: '#/components/responses/InternalServerError'
2522 $ref: '#/components/responses/ServiceUnavailable'
2524 $ref: '#/components/responses/UnexpectedError'
2526 $ref: '#/components/responses/UnexpectedError'
2527 '/nsfm/v1/alarms/{uuid}':
2532 description: Alarm UUID
2538 summary: Read an individual Alarm
2539 description: Read an individual Alarm
2540 operationId: getAlarm
2547 $ref: '#/components/schemas/Alarm'
2550 $ref: '#/components/schemas/Alarm'
2552 $ref: '#/components/responses/BadRequest'
2554 $ref: '#/components/responses/Unauthorized'
2556 $ref: '#/components/responses/Forbidden'
2558 $ref: '#/components/responses/NotFound'
2560 $ref: '#/components/responses/MethodNotAllowed'
2562 $ref: '#/components/responses/NotAcceptable'
2564 $ref: '#/components/responses/Conflict'
2566 $ref: '#/components/responses/UnprocessableEntity'
2568 $ref: '#/components/responses/InternalServerError'
2570 $ref: '#/components/responses/ServiceUnavailable'
2572 $ref: '#/components/responses/UnexpectedError'
2574 $ref: '#/components/responses/UnexpectedError'
2578 summary: Modify the data of an individual Alarm
2579 description: Modify the data of an individual Alarm
2580 operationId: updateAlarm
2582 $ref: '#/components/requestBodies/AlarmInfoModifications'
2585 description: No Content
2587 $ref: '#/components/responses/BadRequest'
2589 $ref: '#/components/responses/Unauthorized'
2591 $ref: '#/components/responses/Forbidden'
2593 $ref: '#/components/responses/NotFound'
2595 $ref: '#/components/responses/MethodNotAllowed'
2597 $ref: '#/components/responses/NotAcceptable'
2599 $ref: '#/components/responses/Conflict'
2601 $ref: '#/components/responses/UnprocessableEntity'
2603 $ref: '#/components/responses/InternalServerError'
2605 $ref: '#/components/responses/ServiceUnavailable'
2607 $ref: '#/components/responses/UnexpectedError'
2609 $ref: '#/components/responses/UnexpectedError'
2612 # BEGIN NetSlice Templates
2613 '/nst/v1/netslice_templates':
2616 - "NetSlice templates"
2617 summary: Query information about multiple NetSlice template resources
2618 description: Query information about multiple NetSlice template resources
2619 operationId: getNSTs
2626 $ref: '#/components/schemas/ArrayOfNstInfo'
2629 $ref: '#/components/schemas/ArrayOfNstInfo'
2631 $ref: '#/components/responses/BadRequest'
2633 $ref: '#/components/responses/Unauthorized'
2635 $ref: '#/components/responses/Forbidden'
2637 $ref: '#/components/responses/NotFound'
2639 $ref: '#/components/responses/MethodNotAllowed'
2641 $ref: '#/components/responses/NotAcceptable'
2643 $ref: '#/components/responses/Conflict'
2645 $ref: '#/components/responses/UnprocessableEntity'
2647 $ref: '#/components/responses/InternalServerError'
2649 $ref: '#/components/responses/ServiceUnavailable'
2651 $ref: '#/components/responses/UnexpectedError'
2653 $ref: '#/components/responses/UnexpectedError'
2656 - "NetSlice templates"
2657 summary: Create a new NetSlice template resource
2658 description: Create a new NetSlice template resource
2661 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2664 description: Created
2673 $ref: '#/components/schemas/ObjectId'
2676 $ref: '#/components/schemas/ObjectId'
2678 $ref: '#/components/responses/BadRequest'
2680 $ref: '#/components/responses/Unauthorized'
2682 $ref: '#/components/responses/Forbidden'
2684 $ref: '#/components/responses/NotFound'
2686 $ref: '#/components/responses/MethodNotAllowed'
2688 $ref: '#/components/responses/NotAcceptable'
2690 $ref: '#/components/responses/Conflict'
2692 $ref: '#/components/responses/UnprocessableEntity'
2694 $ref: '#/components/responses/InternalServerError'
2696 $ref: '#/components/responses/ServiceUnavailable'
2698 $ref: '#/components/responses/UnexpectedError'
2700 $ref: '#/components/responses/UnexpectedError'
2701 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2703 - name: netsliceTemplateId
2706 description: NetSlice Template ID
2711 - "NetSlice templates"
2712 summary: Read information about an individual NetSlice template resource
2713 description: Read information about an individual NetSlice template resource
2721 $ref: '#/components/schemas/NstInfo'
2724 $ref: '#/components/schemas/NstInfo'
2726 $ref: '#/components/responses/BadRequest'
2728 $ref: '#/components/responses/Unauthorized'
2730 $ref: '#/components/responses/Forbidden'
2732 $ref: '#/components/responses/NotFound'
2734 $ref: '#/components/responses/MethodNotAllowed'
2736 $ref: '#/components/responses/NotAcceptable'
2738 $ref: '#/components/responses/Conflict'
2740 $ref: '#/components/responses/UnprocessableEntity'
2742 $ref: '#/components/responses/InternalServerError'
2744 $ref: '#/components/responses/ServiceUnavailable'
2746 $ref: '#/components/responses/UnexpectedError'
2748 $ref: '#/components/responses/UnexpectedError'
2751 - "NetSlice templates"
2752 summary: Delete an individual NetSlice template resource
2753 description: Delete an individual NetSlice template resource
2754 operationId: deleteNST
2757 description: No Content
2759 $ref: '#/components/responses/BadRequest'
2761 $ref: '#/components/responses/Unauthorized'
2763 $ref: '#/components/responses/Forbidden'
2765 $ref: '#/components/responses/NotFound'
2767 $ref: '#/components/responses/MethodNotAllowed'
2769 $ref: '#/components/responses/NotAcceptable'
2771 $ref: '#/components/responses/Conflict'
2773 $ref: '#/components/responses/UnprocessableEntity'
2775 $ref: '#/components/responses/InternalServerError'
2777 $ref: '#/components/responses/ServiceUnavailable'
2779 $ref: '#/components/responses/UnexpectedError'
2781 $ref: '#/components/responses/UnexpectedError'
2782 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2784 - name: netsliceTemplateId
2787 description: NetSlice Template ID
2790 - name: artifactPath
2793 description: Artifact Path
2798 - "NetSlice templates"
2799 summary: Fetch individual NetSlice Template artifact
2800 description: Fetch individual NetSlice Template artifact
2801 operationId: getNstArtifact
2806 application/octet-stream:
2811 description: Partial Content
2817 application/octet-stream:
2822 $ref: '#/components/responses/BadRequest'
2824 $ref: '#/components/responses/Unauthorized'
2826 $ref: '#/components/responses/Forbidden'
2828 $ref: '#/components/responses/NotFound'
2830 $ref: '#/components/responses/MethodNotAllowed'
2832 $ref: '#/components/responses/NotAcceptable'
2834 $ref: '#/components/responses/Conflict'
2836 $ref: '#/components/responses/UnprocessableEntity'
2838 $ref: '#/components/responses/InternalServerError'
2840 $ref: '#/components/responses/ServiceUnavailable'
2842 $ref: '#/components/responses/UnexpectedError'
2844 $ref: '#/components/responses/UnexpectedError'
2845 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2847 - name: netsliceTemplateId
2850 description: NetSlice Template ID
2855 - "NetSlice templates"
2856 summary: Read NST of an on-boarded NetSlice Template
2857 description: Read NST of an on-boarded NetSlice Template
2858 operationId: getNstNst
2865 $ref: '#/components/schemas/NetSliceTemplate'
2867 $ref: '#/components/responses/BadRequest'
2869 $ref: '#/components/responses/Unauthorized'
2871 $ref: '#/components/responses/Forbidden'
2873 $ref: '#/components/responses/NotFound'
2875 $ref: '#/components/responses/MethodNotAllowed'
2877 $ref: '#/components/responses/NotAcceptable'
2879 $ref: '#/components/responses/Conflict'
2881 $ref: '#/components/responses/UnprocessableEntity'
2883 $ref: '#/components/responses/InternalServerError'
2885 $ref: '#/components/responses/ServiceUnavailable'
2887 $ref: '#/components/responses/UnexpectedError'
2889 $ref: '#/components/responses/UnexpectedError'
2890 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2892 - name: netsliceTemplateId
2895 description: NetSlice Template ID
2900 - "NetSlice templates"
2901 summary: Fetch the content of a NST
2902 description: Fetch the content of a NST
2903 operationId: getNSTcontent
2910 $ref: '#/components/schemas/NetSlicePackage'
2912 description: Partial Content
2920 $ref: '#/components/schemas/NetSlicePackage'
2922 $ref: '#/components/responses/BadRequest'
2924 $ref: '#/components/responses/Unauthorized'
2926 $ref: '#/components/responses/Forbidden'
2928 $ref: '#/components/responses/NotFound'
2930 $ref: '#/components/responses/MethodNotAllowed'
2932 $ref: '#/components/responses/NotAcceptable'
2934 $ref: '#/components/responses/Conflict'
2936 $ref: '#/components/responses/UnprocessableEntity'
2938 $ref: '#/components/responses/InternalServerError'
2940 $ref: '#/components/responses/ServiceUnavailable'
2942 $ref: '#/components/responses/UnexpectedError'
2944 $ref: '#/components/responses/UnexpectedError'
2947 - "NetSlice templates"
2948 summary: Upload the content of a NST
2949 description: Upload the content of a NST
2950 operationId: updateNSTcontent
2952 $ref: '#/components/requestBodies/NetSlicePackage'
2955 description: Accepted
2957 description: No Content
2959 $ref: '#/components/responses/BadRequest'
2961 $ref: '#/components/responses/Unauthorized'
2963 $ref: '#/components/responses/Forbidden'
2965 $ref: '#/components/responses/NotFound'
2967 $ref: '#/components/responses/MethodNotAllowed'
2969 $ref: '#/components/responses/NotAcceptable'
2971 $ref: '#/components/responses/Conflict'
2973 $ref: '#/components/responses/UnprocessableEntity'
2975 $ref: '#/components/responses/InternalServerError'
2977 $ref: '#/components/responses/ServiceUnavailable'
2979 $ref: '#/components/responses/UnexpectedError'
2981 $ref: '#/components/responses/UnexpectedError'
2982 '/nst/v1/netslice_templates_content':
2985 - "NetSlice templates"
2986 summary: Upload a NetSlice package by providing the content of the NetSlice package
2987 description: Upload a NetSlice package by providing the content of the NetSlice package
2988 operationId: uploadNstContent
2993 $ref: '#/components/schemas/NetSlicePackage'
2996 description: Created
3005 $ref: '#/components/schemas/ObjectId'
3008 $ref: '#/components/schemas/ObjectId'
3010 description: Accepted
3012 description: No Content
3014 $ref: '#/components/responses/BadRequest'
3016 $ref: '#/components/responses/Unauthorized'
3018 $ref: '#/components/responses/Forbidden'
3020 $ref: '#/components/responses/NotFound'
3022 $ref: '#/components/responses/MethodNotAllowed'
3024 $ref: '#/components/responses/NotAcceptable'
3026 $ref: '#/components/responses/Conflict'
3028 $ref: '#/components/responses/UnprocessableEntity'
3030 $ref: '#/components/responses/InternalServerError'
3032 $ref: '#/components/responses/ServiceUnavailable'
3034 $ref: '#/components/responses/UnexpectedError'
3036 $ref: '#/components/responses/UnexpectedError'
3039 - "NetSlice templates"
3040 summary: Query information about multiple NetSlice Template resources
3041 description: Query information about multiple NetSlice Template resources
3042 operationId: getNstContent
3049 $ref: '#/components/schemas/ArrayOfNstInfo'
3052 $ref: '#/components/schemas/ArrayOfNstInfo'
3054 description: Partial Content
3060 application/octet-stream:
3065 $ref: '#/components/responses/BadRequest'
3067 $ref: '#/components/responses/Unauthorized'
3069 $ref: '#/components/responses/Forbidden'
3071 $ref: '#/components/responses/NotFound'
3073 $ref: '#/components/responses/MethodNotAllowed'
3075 $ref: '#/components/responses/NotAcceptable'
3077 $ref: '#/components/responses/Conflict'
3079 $ref: '#/components/responses/UnprocessableEntity'
3081 $ref: '#/components/responses/InternalServerError'
3083 $ref: '#/components/responses/ServiceUnavailable'
3085 $ref: '#/components/responses/UnexpectedError'
3087 $ref: '#/components/responses/UnexpectedError'
3088 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
3090 - name: netsliceTemplateContentId
3093 description: NetSlice Template ID
3098 - "NetSlice templates"
3099 summary: Read information about an individual NetSlice Template resource
3100 description: Read information about an individual NetSlice Template resource
3101 operationId: getNstIdContent
3108 $ref: '#/components/schemas/NstInfo'
3111 $ref: '#/components/schemas/NstInfo'
3113 $ref: '#/components/responses/BadRequest'
3115 $ref: '#/components/responses/Unauthorized'
3117 $ref: '#/components/responses/Forbidden'
3119 $ref: '#/components/responses/NotFound'
3121 $ref: '#/components/responses/MethodNotAllowed'
3123 $ref: '#/components/responses/NotAcceptable'
3125 $ref: '#/components/responses/Conflict'
3127 $ref: '#/components/responses/UnprocessableEntity'
3129 $ref: '#/components/responses/InternalServerError'
3131 $ref: '#/components/responses/ServiceUnavailable'
3133 $ref: '#/components/responses/UnexpectedError'
3135 $ref: '#/components/responses/UnexpectedError'
3138 - "NetSlice templates"
3139 summary: Modify an individual NetSlice Template resource
3140 description: Modify an individual NetSlice Template resource
3141 operationId: updateNstIdContent
3143 $ref: '#/components/requestBodies/NstInfoModifications'
3146 description: No Content
3148 $ref: '#/components/responses/BadRequest'
3150 $ref: '#/components/responses/Unauthorized'
3152 $ref: '#/components/responses/Forbidden'
3154 $ref: '#/components/responses/NotFound'
3156 $ref: '#/components/responses/MethodNotAllowed'
3158 $ref: '#/components/responses/NotAcceptable'
3160 $ref: '#/components/responses/Conflict'
3162 $ref: '#/components/responses/UnprocessableEntity'
3164 $ref: '#/components/responses/InternalServerError'
3166 $ref: '#/components/responses/ServiceUnavailable'
3168 $ref: '#/components/responses/UnexpectedError'
3170 $ref: '#/components/responses/UnexpectedError'
3173 - "NetSlice templates"
3174 summary: Delete an individual NetSlice Template resource
3175 description: Delete an individual NetSlice Template resource
3176 operationId: deleteNstIdContent
3179 description: No Content
3181 $ref: '#/components/responses/BadRequest'
3183 $ref: '#/components/responses/Unauthorized'
3185 $ref: '#/components/responses/Forbidden'
3187 $ref: '#/components/responses/NotFound'
3189 $ref: '#/components/responses/MethodNotAllowed'
3191 $ref: '#/components/responses/NotAcceptable'
3193 $ref: '#/components/responses/Conflict'
3195 $ref: '#/components/responses/UnprocessableEntity'
3197 $ref: '#/components/responses/InternalServerError'
3199 $ref: '#/components/responses/ServiceUnavailable'
3201 $ref: '#/components/responses/UnexpectedError'
3203 $ref: '#/components/responses/UnexpectedError'
3204 # END NetSlice Templates
3206 # BEGIN NetSlice Instances
3207 '/nsilcm/v1/netslice_instances':
3210 - "NetSlice instances"
3211 summary: Query information about multiple NetSlice instances
3212 description: Query information about multiple NetSlice isntances
3213 operationId: getNSIs
3220 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3223 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3225 $ref: '#/components/responses/BadRequest'
3227 $ref: '#/components/responses/Unauthorized'
3229 $ref: '#/components/responses/Forbidden'
3231 $ref: '#/components/responses/NotFound'
3233 $ref: '#/components/responses/MethodNotAllowed'
3235 $ref: '#/components/responses/NotAcceptable'
3237 $ref: '#/components/responses/Conflict'
3239 $ref: '#/components/responses/UnprocessableEntity'
3241 $ref: '#/components/responses/InternalServerError'
3243 $ref: '#/components/responses/ServiceUnavailable'
3245 $ref: '#/components/responses/UnexpectedError'
3247 $ref: '#/components/responses/UnexpectedError'
3250 - "NetSlice instances"
3251 summary: Create a new NetSlice instance resource
3252 description: Create a new NetSlice instance resource
3255 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3258 description: Created
3267 $ref: '#/components/schemas/ObjectId'
3270 $ref: '#/components/schemas/ObjectId'
3272 $ref: '#/components/responses/BadRequest'
3274 $ref: '#/components/responses/Unauthorized'
3276 $ref: '#/components/responses/Forbidden'
3278 $ref: '#/components/responses/NotFound'
3280 $ref: '#/components/responses/MethodNotAllowed'
3282 $ref: '#/components/responses/NotAcceptable'
3284 $ref: '#/components/responses/Conflict'
3286 $ref: '#/components/responses/UnprocessableEntity'
3288 $ref: '#/components/responses/InternalServerError'
3290 $ref: '#/components/responses/ServiceUnavailable'
3292 $ref: '#/components/responses/UnexpectedError'
3294 $ref: '#/components/responses/UnexpectedError'
3295 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3297 - name: netsliceInstanceId
3300 description: NetSlice Instance ID
3305 - "NetSlice instances"
3306 summary: Read an individual NetSlice instance resource
3307 description: Read an individual NetSlice instance resource
3315 $ref: '#/components/schemas/NetSliceInstance'
3318 $ref: '#/components/schemas/NetSliceInstance'
3320 $ref: '#/components/responses/BadRequest'
3322 $ref: '#/components/responses/Unauthorized'
3324 $ref: '#/components/responses/Forbidden'
3326 $ref: '#/components/responses/NotFound'
3328 $ref: '#/components/responses/MethodNotAllowed'
3330 $ref: '#/components/responses/NotAcceptable'
3332 $ref: '#/components/responses/Conflict'
3334 $ref: '#/components/responses/UnprocessableEntity'
3336 $ref: '#/components/responses/InternalServerError'
3338 $ref: '#/components/responses/ServiceUnavailable'
3340 $ref: '#/components/responses/UnexpectedError'
3342 $ref: '#/components/responses/UnexpectedError'
3345 - "NetSlice instances"
3346 summary: Delete an individual NetSlice instance resource
3347 description: Delete an individual NetSlice instance resource
3348 operationId: deleteNSI
3351 description: No Content
3353 $ref: '#/components/responses/BadRequest'
3355 $ref: '#/components/responses/Unauthorized'
3357 $ref: '#/components/responses/Forbidden'
3359 $ref: '#/components/responses/NotFound'
3361 $ref: '#/components/responses/MethodNotAllowed'
3363 $ref: '#/components/responses/NotAcceptable'
3365 $ref: '#/components/responses/Conflict'
3367 $ref: '#/components/responses/UnprocessableEntity'
3369 $ref: '#/components/responses/InternalServerError'
3371 $ref: '#/components/responses/ServiceUnavailable'
3373 $ref: '#/components/responses/UnexpectedError'
3375 $ref: '#/components/responses/UnexpectedError'
3376 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3378 - name: netsliceInstanceId
3381 description: NetSlice Instance ID
3386 - "NetSlice instances"
3387 summary: Instantiate a NetSlice
3389 Instantiate a NetSlice. The precondition is that the NetSlice instance
3390 must have been created and must be in NOT_INSTANTIATED state. As a result
3391 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3392 Operation Occurrence" resource for the request, and the NS instance state
3393 becomes INSTANTIATED.
3394 operationId: instantiateNSI
3396 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3399 description: Accepted
3403 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3404 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3411 $ref: '#/components/schemas/ObjectId'
3414 $ref: '#/components/schemas/ObjectId'
3416 $ref: '#/components/responses/BadRequest'
3418 $ref: '#/components/responses/Unauthorized'
3420 $ref: '#/components/responses/Forbidden'
3422 $ref: '#/components/responses/NotFound'
3424 $ref: '#/components/responses/MethodNotAllowed'
3426 $ref: '#/components/responses/NotAcceptable'
3428 $ref: '#/components/responses/Conflict'
3430 $ref: '#/components/responses/UnprocessableEntity'
3432 $ref: '#/components/responses/InternalServerError'
3434 $ref: '#/components/responses/ServiceUnavailable'
3436 $ref: '#/components/responses/UnexpectedError'
3438 $ref: '#/components/responses/UnexpectedError'
3439 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3441 - name: netsliceInstanceId
3444 description: NetSlice Instance ID
3449 - "NetSlice instances"
3450 summary: Terminate a NetSlice instance
3452 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3453 must have been created and must be in INSTANTIATED state. As a result of the
3454 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3455 Occurrence" resource for the request, and the NetSlice instance state becomes
3457 operationId: terminateNSI
3459 # Request data is not required
3460 $ref: '#/components/requestBodies/TerminateNsiRequest'
3463 description: Accepted
3467 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3468 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3475 $ref: '#/components/schemas/ObjectId'
3478 $ref: '#/components/schemas/ObjectId'
3480 $ref: '#/components/responses/BadRequest'
3482 $ref: '#/components/responses/Unauthorized'
3484 $ref: '#/components/responses/Forbidden'
3486 $ref: '#/components/responses/NotFound'
3488 $ref: '#/components/responses/MethodNotAllowed'
3490 $ref: '#/components/responses/NotAcceptable'
3492 $ref: '#/components/responses/Conflict'
3494 $ref: '#/components/responses/UnprocessableEntity'
3496 $ref: '#/components/responses/InternalServerError'
3498 $ref: '#/components/responses/ServiceUnavailable'
3500 $ref: '#/components/responses/UnexpectedError'
3502 $ref: '#/components/responses/UnexpectedError'
3503 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3505 - name: netsliceInstanceId
3508 description: NetSlice Instance ID
3513 - "NetSlice instances"
3514 summary: Execute an action on a NetSlice instance
3516 Execute an action on a NetSlice instance.
3517 The NetSlice instance must have been created and must be in INSTANTIATED state.
3518 operationId: actionOnNSI
3523 $ref: '#/components/schemas/NsiActionRequest'
3526 $ref: '#/components/schemas/NsiActionRequest'
3529 description: Accepted
3533 It must point to the new "NS Lifecycle Operation Occurrence"
3534 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3541 $ref: '#/components/schemas/ObjectId'
3544 $ref: '#/components/schemas/ObjectId'
3546 $ref: '#/components/responses/BadRequest'
3548 $ref: '#/components/responses/Unauthorized'
3550 $ref: '#/components/responses/Forbidden'
3552 $ref: '#/components/responses/NotFound'
3554 $ref: '#/components/responses/MethodNotAllowed'
3556 $ref: '#/components/responses/NotAcceptable'
3558 $ref: '#/components/responses/Conflict'
3560 $ref: '#/components/responses/UnprocessableEntity'
3562 $ref: '#/components/responses/InternalServerError'
3564 $ref: '#/components/responses/ServiceUnavailable'
3566 $ref: '#/components/responses/UnexpectedError'
3568 $ref: '#/components/responses/UnexpectedError'
3569 '/nsilcm/v1/netslice_instances_content':
3572 - "NetSlice instances"
3573 summary: Query information about multiple NetSlice instances
3574 description: Query information about multiple NetSlice isntances
3575 operationId: getNSIsContent
3582 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3585 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3587 $ref: '#/components/responses/BadRequest'
3589 $ref: '#/components/responses/Unauthorized'
3591 $ref: '#/components/responses/Forbidden'
3593 $ref: '#/components/responses/NotFound'
3595 $ref: '#/components/responses/MethodNotAllowed'
3597 $ref: '#/components/responses/NotAcceptable'
3599 $ref: '#/components/responses/Conflict'
3601 $ref: '#/components/responses/UnprocessableEntity'
3603 $ref: '#/components/responses/InternalServerError'
3605 $ref: '#/components/responses/ServiceUnavailable'
3607 $ref: '#/components/responses/UnexpectedError'
3609 $ref: '#/components/responses/UnexpectedError'
3612 - "NetSlice instances"
3613 summary: Create a new NetSlice instance
3614 description: Create a new NetSlice instance
3615 operationId: createNSIContent
3617 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3620 description: Created
3629 $ref: '#/components/schemas/CreateNsiContentResponse'
3632 $ref: '#/components/schemas/CreateNsiContentResponse'
3634 $ref: '#/components/responses/BadRequest'
3636 $ref: '#/components/responses/Unauthorized'
3638 $ref: '#/components/responses/Forbidden'
3640 $ref: '#/components/responses/NotFound'
3642 $ref: '#/components/responses/MethodNotAllowed'
3644 $ref: '#/components/responses/NotAcceptable'
3646 $ref: '#/components/responses/Conflict'
3648 $ref: '#/components/responses/UnprocessableEntity'
3650 $ref: '#/components/responses/InternalServerError'
3652 $ref: '#/components/responses/ServiceUnavailable'
3654 $ref: '#/components/responses/UnexpectedError'
3656 $ref: '#/components/responses/UnexpectedError'
3657 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3659 - name: netsliceInstanceContentId
3662 description: NetSlice Instance Content ID
3667 - "NetSlice instances"
3668 summary: Read an individual NetSlice instance resource
3669 description: Read an individual NetSlice instance resource
3670 operationId: getNSIContent
3677 $ref: '#/components/schemas/NetSliceInstance'
3680 $ref: '#/components/schemas/NetSliceInstance'
3682 $ref: '#/components/responses/BadRequest'
3684 $ref: '#/components/responses/Unauthorized'
3686 $ref: '#/components/responses/Forbidden'
3688 $ref: '#/components/responses/NotFound'
3690 $ref: '#/components/responses/MethodNotAllowed'
3692 $ref: '#/components/responses/NotAcceptable'
3694 $ref: '#/components/responses/Conflict'
3696 $ref: '#/components/responses/UnprocessableEntity'
3698 $ref: '#/components/responses/InternalServerError'
3700 $ref: '#/components/responses/ServiceUnavailable'
3702 $ref: '#/components/responses/UnexpectedError'
3704 $ref: '#/components/responses/UnexpectedError'
3707 - "NetSlice instances"
3708 summary: Delete an individual NS instance resource
3709 description: Delete an individual NS instance resource
3710 operationId: deleteNSIContent
3713 description: Accepted
3717 $ref: '#/components/schemas/ObjectId'
3720 $ref: '#/components/schemas/ObjectId'
3722 description: No Content
3724 $ref: '#/components/responses/BadRequest'
3726 $ref: '#/components/responses/Unauthorized'
3728 $ref: '#/components/responses/Forbidden'
3730 $ref: '#/components/responses/NotFound'
3732 $ref: '#/components/responses/MethodNotAllowed'
3734 $ref: '#/components/responses/NotAcceptable'
3736 $ref: '#/components/responses/Conflict'
3738 $ref: '#/components/responses/UnprocessableEntity'
3740 $ref: '#/components/responses/InternalServerError'
3742 $ref: '#/components/responses/ServiceUnavailable'
3744 $ref: '#/components/responses/UnexpectedError'
3746 $ref: '#/components/responses/UnexpectedError'
3747 '/nsilcm/v1/nsi_lcm_op_occs':
3750 - "NetSlice instances"
3751 summary: Query information about multiple NetSlice LCM Operation Occurrences
3752 description: Query information about multiple NetSlice LCM Operation Occurrences
3753 operationId: getNsiLcmOpOccs
3760 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3763 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3765 $ref: '#/components/responses/BadRequest'
3767 $ref: '#/components/responses/Unauthorized'
3769 $ref: '#/components/responses/Forbidden'
3771 $ref: '#/components/responses/NotFound'
3773 $ref: '#/components/responses/MethodNotAllowed'
3775 $ref: '#/components/responses/NotAcceptable'
3777 $ref: '#/components/responses/Conflict'
3779 $ref: '#/components/responses/UnprocessableEntity'
3781 $ref: '#/components/responses/InternalServerError'
3783 $ref: '#/components/responses/ServiceUnavailable'
3785 $ref: '#/components/responses/UnexpectedError'
3787 $ref: '#/components/responses/UnexpectedError'
3788 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3790 - name: nsiLcmOpOccId
3793 description: NetSlice LCM Operation Occurrence ID
3798 - "NetSlice instances"
3799 summary: Query information about an individual NetSlice LCM Operation Occurrence
3800 description: Query information about an individual NetSlice LCM Operation Occurrence
3801 operationId: getNsiLcmOpOcc
3808 $ref: '#/components/schemas/NsiLcmOpOcc'
3811 $ref: '#/components/schemas/NsiLcmOpOcc'
3813 $ref: '#/components/responses/BadRequest'
3815 $ref: '#/components/responses/Unauthorized'
3817 $ref: '#/components/responses/Forbidden'
3819 $ref: '#/components/responses/NotFound'
3821 $ref: '#/components/responses/MethodNotAllowed'
3823 $ref: '#/components/responses/NotAcceptable'
3825 $ref: '#/components/responses/Conflict'
3827 $ref: '#/components/responses/UnprocessableEntity'
3829 $ref: '#/components/responses/InternalServerError'
3831 $ref: '#/components/responses/ServiceUnavailable'
3833 $ref: '#/components/responses/UnexpectedError'
3835 $ref: '#/components/responses/UnexpectedError'
3836 # END NetSlice Instances
3839 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3844 description: NS PM Job ID
3855 - "NS Performance Management"
3856 summary: Query information about an individual NS PM Job Report
3857 description: Query information about an individual NS PM Job Report
3858 operationId: getNsPmJobReport
3865 $ref: '#/components/schemas/NsPmJobReportInfo'
3868 $ref: '#/components/schemas/NsPmJobReportInfo'
3870 $ref: '#/components/responses/BadRequest'
3872 $ref: '#/components/responses/Unauthorized'
3874 $ref: '#/components/responses/Forbidden'
3876 $ref: '#/components/responses/NotFound'
3878 $ref: '#/components/responses/MethodNotAllowed'
3880 $ref: '#/components/responses/NotAcceptable'
3882 $ref: '#/components/responses/Conflict'
3884 $ref: '#/components/responses/UnprocessableEntity'
3886 $ref: '#/components/responses/InternalServerError'
3888 $ref: '#/components/responses/ServiceUnavailable'
3890 $ref: '#/components/responses/UnexpectedError'
3892 $ref: '#/components/responses/UnexpectedError'
3896 '/pdu/v1/pdu_descriptors':
3899 - "Physical Data Units (PDU)"
3900 summary: Query information about multiple PDU Descriptors
3901 description: Query information about multiple PDU Descriptors
3902 operationId: getPDUs
3909 $ref: '#/components/schemas/ArrayOfPduInfo'
3912 $ref: '#/components/schemas/ArrayOfPduInfo'
3914 $ref: '#/components/responses/BadRequest'
3916 $ref: '#/components/responses/Unauthorized'
3918 $ref: '#/components/responses/Forbidden'
3920 $ref: '#/components/responses/NotFound'
3922 $ref: '#/components/responses/MethodNotAllowed'
3924 $ref: '#/components/responses/NotAcceptable'
3926 $ref: '#/components/responses/Conflict'
3928 $ref: '#/components/responses/UnprocessableEntity'
3930 $ref: '#/components/responses/InternalServerError'
3932 $ref: '#/components/responses/ServiceUnavailable'
3934 $ref: '#/components/responses/UnexpectedError'
3936 $ref: '#/components/responses/UnexpectedError'
3939 - "Physical Data Units (PDU)"
3940 summary: Create a new PDU
3941 description: Create a new PDU Descriptor
3942 operationId: createPDU
3944 $ref: '#/components/requestBodies/CreatePduRequest'
3956 $ref: '#/components/schemas/ObjectId'
3959 $ref: '#/components/schemas/ObjectId'
3961 $ref: '#/components/responses/BadRequest'
3963 $ref: '#/components/responses/Unauthorized'
3965 $ref: '#/components/responses/Forbidden'
3967 $ref: '#/components/responses/NotFound'
3969 $ref: '#/components/responses/MethodNotAllowed'
3971 $ref: '#/components/responses/NotAcceptable'
3973 $ref: '#/components/responses/Conflict'
3975 $ref: '#/components/responses/UnprocessableEntity'
3977 $ref: '#/components/responses/InternalServerError'
3979 $ref: '#/components/responses/ServiceUnavailable'
3981 $ref: '#/components/responses/UnexpectedError'
3983 $ref: '#/components/responses/UnexpectedError'
3984 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3986 - name: pduDescriptorId
3989 description: PDU Descriptor ID
3994 - "Physical Data Units (PDU)"
3995 summary: Query information about an individual PDU Descriptor
3996 description: Query information about an individual PDU Descriptor
4004 $ref: '#/components/schemas/PduInfo'
4007 $ref: '#/components/schemas/PduInfo'
4009 $ref: '#/components/responses/BadRequest'
4011 $ref: '#/components/responses/Unauthorized'
4013 $ref: '#/components/responses/Forbidden'
4015 $ref: '#/components/responses/NotFound'
4017 $ref: '#/components/responses/MethodNotAllowed'
4019 $ref: '#/components/responses/NotAcceptable'
4021 $ref: '#/components/responses/Conflict'
4023 $ref: '#/components/responses/UnprocessableEntity'
4025 $ref: '#/components/responses/InternalServerError'
4027 $ref: '#/components/responses/ServiceUnavailable'
4029 $ref: '#/components/responses/UnexpectedError'
4031 $ref: '#/components/responses/UnexpectedError'
4034 - "Physical Data Units (PDU)"
4035 summary: Modify an individual PDU Descriptor
4036 description: Modify an individual PDU Descriptor
4037 operationId: editPDU
4039 $ref: '#/components/requestBodies/EditPduRequest'
4042 description: No Content
4044 $ref: '#/components/responses/BadRequest'
4046 $ref: '#/components/responses/Unauthorized'
4048 $ref: '#/components/responses/Forbidden'
4050 $ref: '#/components/responses/NotFound'
4052 $ref: '#/components/responses/MethodNotAllowed'
4054 $ref: '#/components/responses/NotAcceptable'
4056 $ref: '#/components/responses/Conflict'
4058 $ref: '#/components/responses/UnprocessableEntity'
4060 $ref: '#/components/responses/InternalServerError'
4062 $ref: '#/components/responses/ServiceUnavailable'
4064 $ref: '#/components/responses/UnexpectedError'
4066 $ref: '#/components/responses/UnexpectedError'
4069 - "Physical Data Units (PDU)"
4070 summary: Delete an individual PDU Descriptor
4071 description: Delete an individual PDU Descriptor
4072 operationId: deletePDU
4075 description: No Content
4077 $ref: '#/components/responses/BadRequest'
4079 $ref: '#/components/responses/Unauthorized'
4081 $ref: '#/components/responses/Forbidden'
4083 $ref: '#/components/responses/NotFound'
4085 $ref: '#/components/responses/MethodNotAllowed'
4087 $ref: '#/components/responses/NotAcceptable'
4089 $ref: '#/components/responses/Conflict'
4091 $ref: '#/components/responses/UnprocessableEntity'
4093 $ref: '#/components/responses/InternalServerError'
4095 $ref: '#/components/responses/ServiceUnavailable'
4097 $ref: '#/components/responses/UnexpectedError'
4099 $ref: '#/components/responses/UnexpectedError'
4108 summary: Query information about multiple Tokens
4109 description: Query information about multiple Tokens
4110 operationId: getTokens
4117 $ref: '#/components/schemas/ArrayOfTokenInfo'
4120 $ref: '#/components/schemas/ArrayOfTokenInfo'
4122 $ref: '#/components/responses/BadRequest'
4124 $ref: '#/components/responses/Unauthorized'
4126 $ref: '#/components/responses/Forbidden'
4128 $ref: '#/components/responses/NotFound'
4130 $ref: '#/components/responses/MethodNotAllowed'
4132 $ref: '#/components/responses/NotAcceptable'
4134 $ref: '#/components/responses/Conflict'
4136 $ref: '#/components/responses/UnprocessableEntity'
4138 $ref: '#/components/responses/InternalServerError'
4140 $ref: '#/components/responses/ServiceUnavailable'
4142 $ref: '#/components/responses/UnexpectedError'
4144 $ref: '#/components/responses/UnexpectedError'
4149 summary: Request a new Token
4150 description: Request a new Token
4151 operationId: createToken
4153 $ref: '#/components/requestBodies/CreateTokenRequest'
4166 - $ref: '#/components/schemas/TokenInfo'
4167 - $ref: '#/components/schemas/PasswordExpiryInfo'
4171 - $ref: '#/components/schemas/TokenInfo'
4172 - $ref: '#/components/schemas/PasswordExpiryInfo'
4174 $ref: '#/components/responses/BadRequest'
4176 $ref: '#/components/responses/Unauthorized'
4178 $ref: '#/components/responses/Forbidden'
4180 $ref: '#/components/responses/NotFound'
4182 $ref: '#/components/responses/MethodNotAllowed'
4184 $ref: '#/components/responses/NotAcceptable'
4186 $ref: '#/components/responses/Conflict'
4188 $ref: '#/components/responses/UnprocessableEntity'
4190 $ref: '#/components/responses/InternalServerError'
4192 $ref: '#/components/responses/ServiceUnavailable'
4194 $ref: '#/components/responses/UnexpectedError'
4196 $ref: '#/components/responses/UnexpectedError'
4201 summary: Delete the Token indicated in the Authorization Header
4202 description: Delete the Token indicated in the Authorization Header
4203 operationId: deleteAuthToken
4215 $ref: '#/components/responses/BadRequest'
4217 $ref: '#/components/responses/Unauthorized'
4219 $ref: '#/components/responses/Forbidden'
4221 $ref: '#/components/responses/NotFound'
4223 $ref: '#/components/responses/MethodNotAllowed'
4225 $ref: '#/components/responses/NotAcceptable'
4227 $ref: '#/components/responses/Conflict'
4229 $ref: '#/components/responses/UnprocessableEntity'
4231 $ref: '#/components/responses/InternalServerError'
4233 $ref: '#/components/responses/ServiceUnavailable'
4235 $ref: '#/components/responses/UnexpectedError'
4237 $ref: '#/components/responses/UnexpectedError'
4238 '/admin/v1/tokens/{tokenId}':
4243 description: Token ID
4250 summary: Query information about an individual Token
4251 description: Query information about an individual Token
4252 operationId: getToken
4259 $ref: '#/components/schemas/TokenInfo'
4262 $ref: '#/components/schemas/TokenInfo'
4264 $ref: '#/components/responses/BadRequest'
4266 $ref: '#/components/responses/Unauthorized'
4268 $ref: '#/components/responses/Forbidden'
4270 $ref: '#/components/responses/NotFound'
4272 $ref: '#/components/responses/MethodNotAllowed'
4274 $ref: '#/components/responses/NotAcceptable'
4276 $ref: '#/components/responses/Conflict'
4278 $ref: '#/components/responses/UnprocessableEntity'
4280 $ref: '#/components/responses/InternalServerError'
4282 $ref: '#/components/responses/ServiceUnavailable'
4284 $ref: '#/components/responses/UnexpectedError'
4286 $ref: '#/components/responses/UnexpectedError'
4291 summary: Delete the Token indicated as parameter
4292 description: Delete the Token indicated as parameter
4293 operationId: deleteToken
4305 $ref: '#/components/responses/BadRequest'
4307 $ref: '#/components/responses/Unauthorized'
4309 $ref: '#/components/responses/Forbidden'
4311 $ref: '#/components/responses/NotFound'
4313 $ref: '#/components/responses/MethodNotAllowed'
4315 $ref: '#/components/responses/NotAcceptable'
4317 $ref: '#/components/responses/Conflict'
4319 $ref: '#/components/responses/UnprocessableEntity'
4321 $ref: '#/components/responses/InternalServerError'
4323 $ref: '#/components/responses/ServiceUnavailable'
4325 $ref: '#/components/responses/UnexpectedError'
4327 $ref: '#/components/responses/UnexpectedError'
4333 summary: Query information about multiple Users
4334 description: Query information about multiple Users
4335 operationId: getUsers
4342 $ref: '#/components/schemas/ArrayOfUserInfo'
4345 $ref: '#/components/schemas/ArrayOfUserInfo'
4347 $ref: '#/components/responses/BadRequest'
4349 $ref: '#/components/responses/Unauthorized'
4351 $ref: '#/components/responses/Forbidden'
4353 $ref: '#/components/responses/NotFound'
4355 $ref: '#/components/responses/MethodNotAllowed'
4357 $ref: '#/components/responses/NotAcceptable'
4359 $ref: '#/components/responses/Conflict'
4361 $ref: '#/components/responses/UnprocessableEntity'
4363 $ref: '#/components/responses/InternalServerError'
4365 $ref: '#/components/responses/ServiceUnavailable'
4367 $ref: '#/components/responses/UnexpectedError'
4369 $ref: '#/components/responses/UnexpectedError'
4374 summary: Create a new User
4375 description: Create a new User
4376 operationId: createUser
4378 $ref: '#/components/requestBodies/CreateUserRequest'
4381 description: Created
4390 $ref: '#/components/schemas/ObjectId'
4393 $ref: '#/components/schemas/ObjectId'
4395 $ref: '#/components/responses/BadRequest'
4397 $ref: '#/components/responses/Unauthorized'
4399 $ref: '#/components/responses/Forbidden'
4401 $ref: '#/components/responses/NotFound'
4403 $ref: '#/components/responses/MethodNotAllowed'
4405 $ref: '#/components/responses/NotAcceptable'
4407 $ref: '#/components/responses/Conflict'
4409 $ref: '#/components/responses/UnprocessableEntity'
4411 $ref: '#/components/responses/InternalServerError'
4413 $ref: '#/components/responses/ServiceUnavailable'
4415 $ref: '#/components/responses/UnexpectedError'
4417 $ref: '#/components/responses/UnexpectedError'
4418 '/admin/v1/users/{userId}':
4423 description: User ID/Name
4430 summary: Query information about an individual User
4431 description: Query information about an individual User
4432 operationId: getUser
4439 $ref: '#/components/schemas/UserInfo'
4442 $ref: '#/components/schemas/UserInfo'
4444 $ref: '#/components/responses/BadRequest'
4446 $ref: '#/components/responses/Unauthorized'
4448 $ref: '#/components/responses/Forbidden'
4450 $ref: '#/components/responses/NotFound'
4452 $ref: '#/components/responses/MethodNotAllowed'
4454 $ref: '#/components/responses/NotAcceptable'
4456 $ref: '#/components/responses/Conflict'
4458 $ref: '#/components/responses/UnprocessableEntity'
4460 $ref: '#/components/responses/InternalServerError'
4462 $ref: '#/components/responses/ServiceUnavailable'
4464 $ref: '#/components/responses/UnexpectedError'
4466 $ref: '#/components/responses/UnexpectedError'
4471 summary: Modify a User
4472 description: Modify a User
4473 operationId: editUser
4475 $ref: '#/components/requestBodies/EditUserRequest'
4478 description: No Content
4480 $ref: '#/components/responses/BadRequest'
4482 $ref: '#/components/responses/Unauthorized'
4484 $ref: '#/components/responses/Forbidden'
4486 $ref: '#/components/responses/NotFound'
4488 $ref: '#/components/responses/MethodNotAllowed'
4490 $ref: '#/components/responses/NotAcceptable'
4492 $ref: '#/components/responses/Conflict'
4494 $ref: '#/components/responses/UnprocessableEntity'
4496 $ref: '#/components/responses/InternalServerError'
4498 $ref: '#/components/responses/ServiceUnavailable'
4500 $ref: '#/components/responses/UnexpectedError'
4502 $ref: '#/components/responses/UnexpectedError'
4507 summary: Delete a User
4508 description: Delete a User
4509 operationId: deleteUser
4512 description: No Content
4514 $ref: '#/components/responses/BadRequest'
4516 $ref: '#/components/responses/Unauthorized'
4518 $ref: '#/components/responses/Forbidden'
4520 $ref: '#/components/responses/NotFound'
4522 $ref: '#/components/responses/MethodNotAllowed'
4524 $ref: '#/components/responses/NotAcceptable'
4526 $ref: '#/components/responses/Conflict'
4528 $ref: '#/components/responses/UnprocessableEntity'
4530 $ref: '#/components/responses/InternalServerError'
4532 $ref: '#/components/responses/ServiceUnavailable'
4534 $ref: '#/components/responses/UnexpectedError'
4536 $ref: '#/components/responses/UnexpectedError'
4537 '/admin/v1/projects':
4542 summary: Query information about multiple Projects
4543 description: Query information about multiple Projects
4544 operationId: getProjects
4551 $ref: '#/components/schemas/ArrayOfProjectInfo'
4554 $ref: '#/components/schemas/ArrayOfProjectInfo'
4556 $ref: '#/components/responses/BadRequest'
4558 $ref: '#/components/responses/Unauthorized'
4560 $ref: '#/components/responses/Forbidden'
4562 $ref: '#/components/responses/NotFound'
4564 $ref: '#/components/responses/MethodNotAllowed'
4566 $ref: '#/components/responses/NotAcceptable'
4568 $ref: '#/components/responses/Conflict'
4570 $ref: '#/components/responses/UnprocessableEntity'
4572 $ref: '#/components/responses/InternalServerError'
4574 $ref: '#/components/responses/ServiceUnavailable'
4576 $ref: '#/components/responses/UnexpectedError'
4578 $ref: '#/components/responses/UnexpectedError'
4583 summary: Create a new Project
4584 description: Create a new Project
4585 operationId: createProject
4587 $ref: '#/components/requestBodies/CreateProjectRequest'
4590 description: Created
4599 $ref: '#/components/schemas/ObjectId'
4602 $ref: '#/components/schemas/ObjectId'
4604 $ref: '#/components/responses/BadRequest'
4606 $ref: '#/components/responses/Unauthorized'
4608 $ref: '#/components/responses/Forbidden'
4610 $ref: '#/components/responses/NotFound'
4612 $ref: '#/components/responses/MethodNotAllowed'
4614 $ref: '#/components/responses/NotAcceptable'
4616 $ref: '#/components/responses/Conflict'
4618 $ref: '#/components/responses/UnprocessableEntity'
4620 $ref: '#/components/responses/InternalServerError'
4622 $ref: '#/components/responses/ServiceUnavailable'
4624 $ref: '#/components/responses/UnexpectedError'
4626 $ref: '#/components/responses/UnexpectedError'
4627 '/admin/v1/projects/{projectId}':
4632 description: Project ID/Name
4639 summary: Query information about an individual Project
4640 description: Query information about an individual Project
4641 operationId: getProject
4648 $ref: '#/components/schemas/ProjectInfo'
4651 $ref: '#/components/schemas/ProjectInfo'
4653 $ref: '#/components/responses/BadRequest'
4655 $ref: '#/components/responses/Unauthorized'
4657 $ref: '#/components/responses/Forbidden'
4659 $ref: '#/components/responses/NotFound'
4661 $ref: '#/components/responses/MethodNotAllowed'
4663 $ref: '#/components/responses/NotAcceptable'
4665 $ref: '#/components/responses/Conflict'
4667 $ref: '#/components/responses/UnprocessableEntity'
4669 $ref: '#/components/responses/InternalServerError'
4671 $ref: '#/components/responses/ServiceUnavailable'
4673 $ref: '#/components/responses/UnexpectedError'
4675 $ref: '#/components/responses/UnexpectedError'
4680 summary: Modify a Project
4681 description: Modify a Project
4682 operationId: editProject
4684 $ref: '#/components/requestBodies/EditProjectRequest'
4687 description: No Content
4689 $ref: '#/components/responses/BadRequest'
4691 $ref: '#/components/responses/Unauthorized'
4693 $ref: '#/components/responses/Forbidden'
4695 $ref: '#/components/responses/NotFound'
4697 $ref: '#/components/responses/MethodNotAllowed'
4699 $ref: '#/components/responses/NotAcceptable'
4701 $ref: '#/components/responses/Conflict'
4703 $ref: '#/components/responses/UnprocessableEntity'
4705 $ref: '#/components/responses/InternalServerError'
4707 $ref: '#/components/responses/ServiceUnavailable'
4709 $ref: '#/components/responses/UnexpectedError'
4711 $ref: '#/components/responses/UnexpectedError'
4716 summary: Delete a Project
4717 description: Delete a Project
4718 operationId: deleteProject
4721 description: No Content
4723 $ref: '#/components/responses/BadRequest'
4725 $ref: '#/components/responses/Unauthorized'
4727 $ref: '#/components/responses/Forbidden'
4729 $ref: '#/components/responses/NotFound'
4731 $ref: '#/components/responses/MethodNotAllowed'
4733 $ref: '#/components/responses/NotAcceptable'
4735 $ref: '#/components/responses/Conflict'
4737 $ref: '#/components/responses/UnprocessableEntity'
4739 $ref: '#/components/responses/InternalServerError'
4741 $ref: '#/components/responses/ServiceUnavailable'
4743 $ref: '#/components/responses/UnexpectedError'
4745 $ref: '#/components/responses/UnexpectedError'
4751 summary: Query information about multiple Roles
4752 description: Query information about multiple Roles
4753 operationId: getRoles
4760 $ref: '#/components/schemas/ArrayOfRoleInfo'
4763 $ref: '#/components/schemas/ArrayOfRoleInfo'
4765 $ref: '#/components/responses/BadRequest'
4767 $ref: '#/components/responses/Unauthorized'
4769 $ref: '#/components/responses/Forbidden'
4771 $ref: '#/components/responses/NotFound'
4773 $ref: '#/components/responses/MethodNotAllowed'
4775 $ref: '#/components/responses/NotAcceptable'
4777 $ref: '#/components/responses/Conflict'
4779 $ref: '#/components/responses/UnprocessableEntity'
4781 $ref: '#/components/responses/InternalServerError'
4783 $ref: '#/components/responses/ServiceUnavailable'
4785 $ref: '#/components/responses/UnexpectedError'
4787 $ref: '#/components/responses/UnexpectedError'
4792 summary: Create a new Role
4793 description: Create a new Role
4794 operationId: createRole
4796 $ref: '#/components/requestBodies/CreateRoleRequest'
4799 description: Created
4808 $ref: '#/components/schemas/ObjectId'
4811 $ref: '#/components/schemas/ObjectId'
4813 $ref: '#/components/responses/BadRequest'
4815 $ref: '#/components/responses/Unauthorized'
4817 $ref: '#/components/responses/Forbidden'
4819 $ref: '#/components/responses/NotFound'
4821 $ref: '#/components/responses/MethodNotAllowed'
4823 $ref: '#/components/responses/NotAcceptable'
4825 $ref: '#/components/responses/Conflict'
4827 $ref: '#/components/responses/UnprocessableEntity'
4829 $ref: '#/components/responses/InternalServerError'
4831 $ref: '#/components/responses/ServiceUnavailable'
4833 $ref: '#/components/responses/UnexpectedError'
4835 $ref: '#/components/responses/UnexpectedError'
4836 '/admin/v1/roles/{roleId}':
4841 description: Role ID/Name
4848 summary: Query information about an individual Role
4849 description: Query information about an individual Role
4850 operationId: getRole
4857 $ref: '#/components/schemas/RoleInfo'
4860 $ref: '#/components/schemas/RoleInfo'
4862 $ref: '#/components/responses/BadRequest'
4864 $ref: '#/components/responses/Unauthorized'
4866 $ref: '#/components/responses/Forbidden'
4868 $ref: '#/components/responses/NotFound'
4870 $ref: '#/components/responses/MethodNotAllowed'
4872 $ref: '#/components/responses/NotAcceptable'
4874 $ref: '#/components/responses/Conflict'
4876 $ref: '#/components/responses/UnprocessableEntity'
4878 $ref: '#/components/responses/InternalServerError'
4880 $ref: '#/components/responses/ServiceUnavailable'
4882 $ref: '#/components/responses/UnexpectedError'
4884 $ref: '#/components/responses/UnexpectedError'
4889 summary: Modify a Role
4890 description: Modify a Role
4891 operationId: editRole
4893 $ref: '#/components/requestBodies/EditRoleRequest'
4896 description: No Content
4898 $ref: '#/components/responses/BadRequest'
4900 $ref: '#/components/responses/Unauthorized'
4902 $ref: '#/components/responses/Forbidden'
4904 $ref: '#/components/responses/NotFound'
4906 $ref: '#/components/responses/MethodNotAllowed'
4908 $ref: '#/components/responses/NotAcceptable'
4910 $ref: '#/components/responses/Conflict'
4912 $ref: '#/components/responses/UnprocessableEntity'
4914 $ref: '#/components/responses/InternalServerError'
4916 $ref: '#/components/responses/ServiceUnavailable'
4918 $ref: '#/components/responses/UnexpectedError'
4920 $ref: '#/components/responses/UnexpectedError'
4925 summary: Delete a Role
4926 description: Delete a Role
4927 operationId: deleteRole
4930 description: No Content
4932 $ref: '#/components/responses/BadRequest'
4934 $ref: '#/components/responses/Unauthorized'
4936 $ref: '#/components/responses/Forbidden'
4938 $ref: '#/components/responses/NotFound'
4940 $ref: '#/components/responses/MethodNotAllowed'
4942 $ref: '#/components/responses/NotAcceptable'
4944 $ref: '#/components/responses/Conflict'
4946 $ref: '#/components/responses/UnprocessableEntity'
4948 $ref: '#/components/responses/InternalServerError'
4950 $ref: '#/components/responses/ServiceUnavailable'
4952 $ref: '#/components/responses/UnexpectedError'
4954 $ref: '#/components/responses/UnexpectedError'
4960 summary: Query information about multiple VIMs
4961 description: Query information about multiple VIMs
4962 operationId: getVIMs
4969 $ref: '#/components/schemas/ArrayOfVimInfo'
4972 $ref: '#/components/schemas/ArrayOfVimInfo'
4974 $ref: '#/components/responses/BadRequest'
4976 $ref: '#/components/responses/Unauthorized'
4978 $ref: '#/components/responses/Forbidden'
4980 $ref: '#/components/responses/NotFound'
4982 $ref: '#/components/responses/MethodNotAllowed'
4984 $ref: '#/components/responses/NotAcceptable'
4986 $ref: '#/components/responses/Conflict'
4988 $ref: '#/components/responses/UnprocessableEntity'
4990 $ref: '#/components/responses/InternalServerError'
4992 $ref: '#/components/responses/ServiceUnavailable'
4994 $ref: '#/components/responses/UnexpectedError'
4996 $ref: '#/components/responses/UnexpectedError'
5001 summary: Create a new VIM
5002 description: Create a new VIM
5003 operationId: createVIM
5005 $ref: '#/components/requestBodies/CreateVimRequest'
5008 description: Accepted
5012 $ref: '#/components/schemas/ObjectId_plus_OpId'
5015 $ref: '#/components/schemas/ObjectId_plus_OpId'
5017 $ref: '#/components/responses/BadRequest'
5019 $ref: '#/components/responses/Unauthorized'
5021 $ref: '#/components/responses/Forbidden'
5023 $ref: '#/components/responses/NotFound'
5025 $ref: '#/components/responses/MethodNotAllowed'
5027 $ref: '#/components/responses/NotAcceptable'
5029 $ref: '#/components/responses/Conflict'
5031 $ref: '#/components/responses/UnprocessableEntity'
5033 $ref: '#/components/responses/InternalServerError'
5035 $ref: '#/components/responses/ServiceUnavailable'
5037 $ref: '#/components/responses/UnexpectedError'
5039 $ref: '#/components/responses/UnexpectedError'
5040 '/admin/v1/vims/{vimId}':
5053 summary: Query information about an individual VIM
5054 description: Query information about an individual VIM
5062 $ref: '#/components/schemas/VimInfo'
5065 $ref: '#/components/schemas/VimInfo'
5067 $ref: '#/components/responses/BadRequest'
5069 $ref: '#/components/responses/Unauthorized'
5071 $ref: '#/components/responses/Forbidden'
5073 $ref: '#/components/responses/NotFound'
5075 $ref: '#/components/responses/MethodNotAllowed'
5077 $ref: '#/components/responses/NotAcceptable'
5079 $ref: '#/components/responses/Conflict'
5081 $ref: '#/components/responses/UnprocessableEntity'
5083 $ref: '#/components/responses/InternalServerError'
5085 $ref: '#/components/responses/ServiceUnavailable'
5087 $ref: '#/components/responses/UnexpectedError'
5089 $ref: '#/components/responses/UnexpectedError'
5094 summary: Modify a VIM
5095 description: Modify a VIM
5096 operationId: editVIM
5098 $ref: '#/components/requestBodies/EditVimRequest'
5101 description: Accepted
5105 $ref: '#/components/schemas/OpId'
5108 $ref: '#/components/schemas/OpId'
5110 $ref: '#/components/responses/BadRequest'
5112 $ref: '#/components/responses/Unauthorized'
5114 $ref: '#/components/responses/Forbidden'
5116 $ref: '#/components/responses/NotFound'
5118 $ref: '#/components/responses/MethodNotAllowed'
5120 $ref: '#/components/responses/NotAcceptable'
5122 $ref: '#/components/responses/Conflict'
5124 $ref: '#/components/responses/UnprocessableEntity'
5126 $ref: '#/components/responses/InternalServerError'
5128 $ref: '#/components/responses/ServiceUnavailable'
5130 $ref: '#/components/responses/UnexpectedError'
5132 $ref: '#/components/responses/UnexpectedError'
5137 summary: Delete a VIM
5138 description: Delete a VIM
5139 operationId: deleteVIM
5142 description: Accepted
5144 $ref: '#/components/responses/BadRequest'
5146 $ref: '#/components/responses/Unauthorized'
5148 $ref: '#/components/responses/Forbidden'
5150 $ref: '#/components/responses/NotFound'
5152 $ref: '#/components/responses/MethodNotAllowed'
5154 $ref: '#/components/responses/NotAcceptable'
5156 $ref: '#/components/responses/Conflict'
5158 $ref: '#/components/responses/UnprocessableEntity'
5160 $ref: '#/components/responses/InternalServerError'
5162 $ref: '#/components/responses/ServiceUnavailable'
5164 $ref: '#/components/responses/UnexpectedError'
5166 $ref: '#/components/responses/UnexpectedError'
5167 '/admin/v1/vim_accounts':
5172 summary: Query information about multiple VIM Accounts
5173 description: Query information about multiple VIM Accounts
5174 operationId: getVimAccounts
5181 $ref: '#/components/schemas/ArrayOfVimInfo'
5184 $ref: '#/components/schemas/ArrayOfVimInfo'
5186 $ref: '#/components/responses/BadRequest'
5188 $ref: '#/components/responses/Unauthorized'
5190 $ref: '#/components/responses/Forbidden'
5192 $ref: '#/components/responses/NotFound'
5194 $ref: '#/components/responses/MethodNotAllowed'
5196 $ref: '#/components/responses/NotAcceptable'
5198 $ref: '#/components/responses/Conflict'
5200 $ref: '#/components/responses/UnprocessableEntity'
5202 $ref: '#/components/responses/InternalServerError'
5204 $ref: '#/components/responses/ServiceUnavailable'
5206 $ref: '#/components/responses/UnexpectedError'
5208 $ref: '#/components/responses/UnexpectedError'
5213 summary: Create a new VIM Account
5214 description: Create a new VIM Account
5215 operationId: createVimAccount
5217 $ref: '#/components/requestBodies/CreateVimRequest'
5220 description: Accepted
5224 $ref: '#/components/schemas/ObjectId_plus_OpId'
5227 $ref: '#/components/schemas/ObjectId_plus_OpId'
5229 $ref: '#/components/responses/BadRequest'
5231 $ref: '#/components/responses/Unauthorized'
5233 $ref: '#/components/responses/Forbidden'
5235 $ref: '#/components/responses/NotFound'
5237 $ref: '#/components/responses/MethodNotAllowed'
5239 $ref: '#/components/responses/NotAcceptable'
5241 $ref: '#/components/responses/Conflict'
5243 $ref: '#/components/responses/UnprocessableEntity'
5245 $ref: '#/components/responses/InternalServerError'
5247 $ref: '#/components/responses/ServiceUnavailable'
5249 $ref: '#/components/responses/UnexpectedError'
5251 $ref: '#/components/responses/UnexpectedError'
5252 '/admin/v1/vim_accounts/{vimAccountId}':
5254 - name: vimAccountId
5257 description: VIM Account ID
5265 summary: Query information about an individual VIM Account
5266 description: Query information about an individual VIM Account
5267 operationId: getVimAccount
5274 $ref: '#/components/schemas/VimInfo'
5277 $ref: '#/components/schemas/VimInfo'
5279 $ref: '#/components/responses/BadRequest'
5281 $ref: '#/components/responses/Unauthorized'
5283 $ref: '#/components/responses/Forbidden'
5285 $ref: '#/components/responses/NotFound'
5287 $ref: '#/components/responses/MethodNotAllowed'
5289 $ref: '#/components/responses/NotAcceptable'
5291 $ref: '#/components/responses/Conflict'
5293 $ref: '#/components/responses/UnprocessableEntity'
5295 $ref: '#/components/responses/InternalServerError'
5297 $ref: '#/components/responses/ServiceUnavailable'
5299 $ref: '#/components/responses/UnexpectedError'
5301 $ref: '#/components/responses/UnexpectedError'
5306 summary: Modify a VIM Account
5307 description: Modify a VIM Account
5308 operationId: editVimAccount
5310 $ref: '#/components/requestBodies/EditVimRequest'
5313 description: Accepted
5317 $ref: '#/components/schemas/OpId'
5320 $ref: '#/components/schemas/OpId'
5322 $ref: '#/components/responses/BadRequest'
5324 $ref: '#/components/responses/Unauthorized'
5326 $ref: '#/components/responses/Forbidden'
5328 $ref: '#/components/responses/NotFound'
5330 $ref: '#/components/responses/MethodNotAllowed'
5332 $ref: '#/components/responses/NotAcceptable'
5334 $ref: '#/components/responses/Conflict'
5336 $ref: '#/components/responses/UnprocessableEntity'
5338 $ref: '#/components/responses/InternalServerError'
5340 $ref: '#/components/responses/ServiceUnavailable'
5342 $ref: '#/components/responses/UnexpectedError'
5344 $ref: '#/components/responses/UnexpectedError'
5349 summary: Delete a VIM Account
5350 description: Delete a VIM Account
5351 operationId: deleteVimAccount
5354 description: Accepted
5356 $ref: '#/components/responses/BadRequest'
5358 $ref: '#/components/responses/Unauthorized'
5360 $ref: '#/components/responses/Forbidden'
5362 $ref: '#/components/responses/NotFound'
5364 $ref: '#/components/responses/MethodNotAllowed'
5366 $ref: '#/components/responses/NotAcceptable'
5368 $ref: '#/components/responses/Conflict'
5370 $ref: '#/components/responses/UnprocessableEntity'
5372 $ref: '#/components/responses/InternalServerError'
5374 $ref: '#/components/responses/ServiceUnavailable'
5376 $ref: '#/components/responses/UnexpectedError'
5378 $ref: '#/components/responses/UnexpectedError'
5379 '/admin/v1/wim_accounts':
5384 summary: Query information about multiple WIM Accounts
5385 description: Query information about multiple WIM Accounts
5386 operationId: getWimAccounts
5393 $ref: '#/components/schemas/ArrayOfWimInfo'
5396 $ref: '#/components/schemas/ArrayOfWimInfo'
5398 $ref: '#/components/responses/BadRequest'
5400 $ref: '#/components/responses/Unauthorized'
5402 $ref: '#/components/responses/Forbidden'
5404 $ref: '#/components/responses/NotFound'
5406 $ref: '#/components/responses/MethodNotAllowed'
5408 $ref: '#/components/responses/NotAcceptable'
5410 $ref: '#/components/responses/Conflict'
5412 $ref: '#/components/responses/UnprocessableEntity'
5414 $ref: '#/components/responses/InternalServerError'
5416 $ref: '#/components/responses/ServiceUnavailable'
5418 $ref: '#/components/responses/UnexpectedError'
5420 $ref: '#/components/responses/UnexpectedError'
5425 summary: Create a new WIM Account
5426 description: Create a new WIM Account
5427 operationId: createWimAccount
5429 $ref: '#/components/requestBodies/CreateWimRequest'
5432 description: Accepted
5436 $ref: '#/components/schemas/ObjectId_plus_OpId'
5439 $ref: '#/components/schemas/ObjectId_plus_OpId'
5441 $ref: '#/components/responses/BadRequest'
5443 $ref: '#/components/responses/Unauthorized'
5445 $ref: '#/components/responses/Forbidden'
5447 $ref: '#/components/responses/NotFound'
5449 $ref: '#/components/responses/MethodNotAllowed'
5451 $ref: '#/components/responses/NotAcceptable'
5453 $ref: '#/components/responses/Conflict'
5455 $ref: '#/components/responses/UnprocessableEntity'
5457 $ref: '#/components/responses/InternalServerError'
5459 $ref: '#/components/responses/ServiceUnavailable'
5461 $ref: '#/components/responses/UnexpectedError'
5463 $ref: '#/components/responses/UnexpectedError'
5464 '/admin/v1/wim_accounts/{wimAccountId}':
5466 - name: wimAccountId
5469 description: WIM Account ID
5477 summary: Query information about an individual WIM Account
5478 description: Query information about an individual WIM Account
5479 operationId: getWimAccount
5486 $ref: '#/components/schemas/WimInfo'
5489 $ref: '#/components/schemas/WimInfo'
5491 $ref: '#/components/responses/BadRequest'
5493 $ref: '#/components/responses/Unauthorized'
5495 $ref: '#/components/responses/Forbidden'
5497 $ref: '#/components/responses/NotFound'
5499 $ref: '#/components/responses/MethodNotAllowed'
5501 $ref: '#/components/responses/NotAcceptable'
5503 $ref: '#/components/responses/Conflict'
5505 $ref: '#/components/responses/UnprocessableEntity'
5507 $ref: '#/components/responses/InternalServerError'
5509 $ref: '#/components/responses/ServiceUnavailable'
5511 $ref: '#/components/responses/UnexpectedError'
5513 $ref: '#/components/responses/UnexpectedError'
5518 summary: Modify a WIM Account
5519 description: Modify a WIM Account
5520 operationId: editWimAccount
5522 $ref: '#/components/requestBodies/EditWimRequest'
5525 description: Accepted
5529 $ref: '#/components/schemas/OpId'
5532 $ref: '#/components/schemas/OpId'
5534 $ref: '#/components/responses/BadRequest'
5536 $ref: '#/components/responses/Unauthorized'
5538 $ref: '#/components/responses/Forbidden'
5540 $ref: '#/components/responses/NotFound'
5542 $ref: '#/components/responses/MethodNotAllowed'
5544 $ref: '#/components/responses/NotAcceptable'
5546 $ref: '#/components/responses/Conflict'
5548 $ref: '#/components/responses/UnprocessableEntity'
5550 $ref: '#/components/responses/InternalServerError'
5552 $ref: '#/components/responses/ServiceUnavailable'
5554 $ref: '#/components/responses/UnexpectedError'
5556 $ref: '#/components/responses/UnexpectedError'
5561 summary: Delete a WIM Account
5562 description: Delete a WIM Account
5563 operationId: deleteWimAccount
5566 description: Accepted
5568 $ref: '#/components/responses/BadRequest'
5570 $ref: '#/components/responses/Unauthorized'
5572 $ref: '#/components/responses/Forbidden'
5574 $ref: '#/components/responses/NotFound'
5576 $ref: '#/components/responses/MethodNotAllowed'
5578 $ref: '#/components/responses/NotAcceptable'
5580 $ref: '#/components/responses/Conflict'
5582 $ref: '#/components/responses/UnprocessableEntity'
5584 $ref: '#/components/responses/InternalServerError'
5586 $ref: '#/components/responses/ServiceUnavailable'
5588 $ref: '#/components/responses/UnexpectedError'
5590 $ref: '#/components/responses/UnexpectedError'
5596 summary: Query information about multiple SDNs
5597 description: Query information about multiple SDNs
5598 operationId: getSDNs
5605 $ref: '#/components/schemas/ArrayOfSdnInfo'
5608 $ref: '#/components/schemas/ArrayOfSdnInfo'
5610 $ref: '#/components/responses/BadRequest'
5612 $ref: '#/components/responses/Unauthorized'
5614 $ref: '#/components/responses/Forbidden'
5616 $ref: '#/components/responses/NotFound'
5618 $ref: '#/components/responses/MethodNotAllowed'
5620 $ref: '#/components/responses/NotAcceptable'
5622 $ref: '#/components/responses/Conflict'
5624 $ref: '#/components/responses/UnprocessableEntity'
5626 $ref: '#/components/responses/InternalServerError'
5628 $ref: '#/components/responses/ServiceUnavailable'
5630 $ref: '#/components/responses/UnexpectedError'
5632 $ref: '#/components/responses/UnexpectedError'
5637 summary: Create a new SDN
5638 description: Create a new SDN
5639 operationId: createSDN
5641 $ref: '#/components/requestBodies/CreateSdnRequest'
5644 description: Accepted
5648 $ref: '#/components/schemas/ObjectId_plus_OpId'
5651 $ref: '#/components/schemas/ObjectId_plus_OpId'
5653 $ref: '#/components/responses/BadRequest'
5655 $ref: '#/components/responses/Unauthorized'
5657 $ref: '#/components/responses/Forbidden'
5659 $ref: '#/components/responses/NotFound'
5661 $ref: '#/components/responses/MethodNotAllowed'
5663 $ref: '#/components/responses/NotAcceptable'
5665 $ref: '#/components/responses/Conflict'
5667 $ref: '#/components/responses/UnprocessableEntity'
5669 $ref: '#/components/responses/InternalServerError'
5671 $ref: '#/components/responses/ServiceUnavailable'
5673 $ref: '#/components/responses/UnexpectedError'
5675 $ref: '#/components/responses/UnexpectedError'
5676 '/admin/v1/sdns/{sdnId}':
5689 summary: Query information about an individual SDN
5690 description: Query information about an individual SDN
5698 $ref: '#/components/schemas/SdnInfo'
5701 $ref: '#/components/schemas/SdnInfo'
5703 $ref: '#/components/responses/BadRequest'
5705 $ref: '#/components/responses/Unauthorized'
5707 $ref: '#/components/responses/Forbidden'
5709 $ref: '#/components/responses/NotFound'
5711 $ref: '#/components/responses/MethodNotAllowed'
5713 $ref: '#/components/responses/NotAcceptable'
5715 $ref: '#/components/responses/Conflict'
5717 $ref: '#/components/responses/UnprocessableEntity'
5719 $ref: '#/components/responses/InternalServerError'
5721 $ref: '#/components/responses/ServiceUnavailable'
5723 $ref: '#/components/responses/UnexpectedError'
5725 $ref: '#/components/responses/UnexpectedError'
5730 summary: Modify a SDN
5731 description: Modify a SDN
5732 operationId: editSDN
5734 $ref: '#/components/requestBodies/EditSdnRequest'
5737 description: Accepted
5741 $ref: '#/components/schemas/OpId'
5744 $ref: '#/components/schemas/OpId'
5746 $ref: '#/components/responses/BadRequest'
5748 $ref: '#/components/responses/Unauthorized'
5750 $ref: '#/components/responses/Forbidden'
5752 $ref: '#/components/responses/NotFound'
5754 $ref: '#/components/responses/MethodNotAllowed'
5756 $ref: '#/components/responses/NotAcceptable'
5758 $ref: '#/components/responses/Conflict'
5760 $ref: '#/components/responses/UnprocessableEntity'
5762 $ref: '#/components/responses/InternalServerError'
5764 $ref: '#/components/responses/ServiceUnavailable'
5766 $ref: '#/components/responses/UnexpectedError'
5768 $ref: '#/components/responses/UnexpectedError'
5773 summary: Delete a SDN
5774 description: Delete a SDN
5775 operationId: deleteSDN
5778 description: Accepted
5780 $ref: '#/components/responses/BadRequest'
5782 $ref: '#/components/responses/Unauthorized'
5784 $ref: '#/components/responses/Forbidden'
5786 $ref: '#/components/responses/NotFound'
5788 $ref: '#/components/responses/MethodNotAllowed'
5790 $ref: '#/components/responses/NotAcceptable'
5792 $ref: '#/components/responses/Conflict'
5794 $ref: '#/components/responses/UnprocessableEntity'
5796 $ref: '#/components/responses/InternalServerError'
5798 $ref: '#/components/responses/ServiceUnavailable'
5800 $ref: '#/components/responses/UnexpectedError'
5802 $ref: '#/components/responses/UnexpectedError'
5803 '/admin/v1/k8sclusters':
5808 summary: Query information about multiple K8s Clusters
5809 description: Query information about multiple K8s Clusters
5810 operationId: getK8sClusters
5817 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5820 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5822 $ref: '#/components/responses/BadRequest'
5824 $ref: '#/components/responses/Unauthorized'
5826 $ref: '#/components/responses/Forbidden'
5828 $ref: '#/components/responses/NotFound'
5830 $ref: '#/components/responses/MethodNotAllowed'
5832 $ref: '#/components/responses/NotAcceptable'
5834 $ref: '#/components/responses/Conflict'
5836 $ref: '#/components/responses/UnprocessableEntity'
5838 $ref: '#/components/responses/InternalServerError'
5840 $ref: '#/components/responses/ServiceUnavailable'
5842 $ref: '#/components/responses/UnexpectedError'
5844 $ref: '#/components/responses/UnexpectedError'
5849 summary: Create a new K8s Cluster
5850 description: Create a new K8s Cluster
5851 operationId: createK8sCluster
5853 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5856 description: Accepted
5860 $ref: '#/components/schemas/ObjectId_plus_OpId'
5863 $ref: '#/components/schemas/ObjectId_plus_OpId'
5865 $ref: '#/components/responses/BadRequest'
5867 $ref: '#/components/responses/Unauthorized'
5869 $ref: '#/components/responses/Forbidden'
5871 $ref: '#/components/responses/NotFound'
5873 $ref: '#/components/responses/MethodNotAllowed'
5875 $ref: '#/components/responses/NotAcceptable'
5877 $ref: '#/components/responses/Conflict'
5879 $ref: '#/components/responses/UnprocessableEntity'
5881 $ref: '#/components/responses/InternalServerError'
5883 $ref: '#/components/responses/ServiceUnavailable'
5885 $ref: '#/components/responses/UnexpectedError'
5887 $ref: '#/components/responses/UnexpectedError'
5888 '/admin/v1/k8sclusters/{k8sClusterId}':
5890 - name: k8sClusterId
5893 description: K8s Cluster ID
5901 summary: Query information about an individual K8s Cluster
5902 description: Query information about an individual K8s Cluster
5903 operationId: getK8sCluster
5910 $ref: '#/components/schemas/K8sClusterInfo'
5913 $ref: '#/components/schemas/K8sClusterInfo'
5915 $ref: '#/components/responses/BadRequest'
5917 $ref: '#/components/responses/Unauthorized'
5919 $ref: '#/components/responses/Forbidden'
5921 $ref: '#/components/responses/NotFound'
5923 $ref: '#/components/responses/MethodNotAllowed'
5925 $ref: '#/components/responses/NotAcceptable'
5927 $ref: '#/components/responses/Conflict'
5929 $ref: '#/components/responses/UnprocessableEntity'
5931 $ref: '#/components/responses/InternalServerError'
5933 $ref: '#/components/responses/ServiceUnavailable'
5935 $ref: '#/components/responses/UnexpectedError'
5937 $ref: '#/components/responses/UnexpectedError'
5942 summary: Modify a K8s Cluster
5943 description: Modify a K8s Cluster
5944 operationId: editK8sCluster
5946 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5949 description: Accepted
5953 $ref: '#/components/schemas/OpId'
5956 $ref: '#/components/schemas/OpId'
5958 $ref: '#/components/responses/BadRequest'
5960 $ref: '#/components/responses/Unauthorized'
5962 $ref: '#/components/responses/Forbidden'
5964 $ref: '#/components/responses/NotFound'
5966 $ref: '#/components/responses/MethodNotAllowed'
5968 $ref: '#/components/responses/NotAcceptable'
5970 $ref: '#/components/responses/Conflict'
5972 $ref: '#/components/responses/UnprocessableEntity'
5974 $ref: '#/components/responses/InternalServerError'
5976 $ref: '#/components/responses/ServiceUnavailable'
5978 $ref: '#/components/responses/UnexpectedError'
5980 $ref: '#/components/responses/UnexpectedError'
5985 summary: Delete a K8s Cluster
5986 description: Delete a K8s Cluster
5987 operationId: deleteK8sCluster
5990 description: Accepted
5992 $ref: '#/components/responses/BadRequest'
5994 $ref: '#/components/responses/Unauthorized'
5996 $ref: '#/components/responses/Forbidden'
5998 $ref: '#/components/responses/NotFound'
6000 $ref: '#/components/responses/MethodNotAllowed'
6002 $ref: '#/components/responses/NotAcceptable'
6004 $ref: '#/components/responses/Conflict'
6006 $ref: '#/components/responses/UnprocessableEntity'
6008 $ref: '#/components/responses/InternalServerError'
6010 $ref: '#/components/responses/ServiceUnavailable'
6012 $ref: '#/components/responses/UnexpectedError'
6014 $ref: '#/components/responses/UnexpectedError'
6020 summary: Query information about multiple VCAs
6021 description: Query information about multiple VCAs
6022 operationId: getVcas
6029 $ref: '#/components/schemas/ArrayOfVcaInfo'
6032 $ref: '#/components/schemas/ArrayOfVcaInfo'
6034 $ref: '#/components/responses/BadRequest'
6036 $ref: '#/components/responses/Unauthorized'
6038 $ref: '#/components/responses/Forbidden'
6040 $ref: '#/components/responses/NotFound'
6042 $ref: '#/components/responses/MethodNotAllowed'
6044 $ref: '#/components/responses/NotAcceptable'
6046 $ref: '#/components/responses/Conflict'
6048 $ref: '#/components/responses/UnprocessableEntity'
6050 $ref: '#/components/responses/InternalServerError'
6052 $ref: '#/components/responses/ServiceUnavailable'
6054 $ref: '#/components/responses/UnexpectedError'
6056 $ref: '#/components/responses/UnexpectedError'
6061 summary: Create a new VCA
6062 description: Create a new VCA
6063 operationId: createVca
6065 $ref: '#/components/requestBodies/CreateVcaRequest'
6068 description: Accepted
6072 $ref: '#/components/schemas/ObjectId_plus_OpId'
6075 $ref: '#/components/schemas/ObjectId_plus_OpId'
6077 $ref: '#/components/responses/BadRequest'
6079 $ref: '#/components/responses/Unauthorized'
6081 $ref: '#/components/responses/Forbidden'
6083 $ref: '#/components/responses/NotFound'
6085 $ref: '#/components/responses/MethodNotAllowed'
6087 $ref: '#/components/responses/NotAcceptable'
6089 $ref: '#/components/responses/Conflict'
6091 $ref: '#/components/responses/UnprocessableEntity'
6093 $ref: '#/components/responses/InternalServerError'
6095 $ref: '#/components/responses/ServiceUnavailable'
6097 $ref: '#/components/responses/UnexpectedError'
6099 $ref: '#/components/responses/UnexpectedError'
6100 '/admin/v1/vca/{vcaId}':
6113 summary: Query information about an individual VCA
6114 description: Query information about an individual VCA
6122 $ref: '#/components/schemas/VcaInfo'
6125 $ref: '#/components/schemas/VcaInfo'
6127 $ref: '#/components/responses/BadRequest'
6129 $ref: '#/components/responses/Unauthorized'
6131 $ref: '#/components/responses/Forbidden'
6133 $ref: '#/components/responses/NotFound'
6135 $ref: '#/components/responses/MethodNotAllowed'
6137 $ref: '#/components/responses/NotAcceptable'
6139 $ref: '#/components/responses/Conflict'
6141 $ref: '#/components/responses/UnprocessableEntity'
6143 $ref: '#/components/responses/InternalServerError'
6145 $ref: '#/components/responses/ServiceUnavailable'
6147 $ref: '#/components/responses/UnexpectedError'
6149 $ref: '#/components/responses/UnexpectedError'
6154 summary: Modify a VCA
6155 description: Modify a VCA
6156 operationId: editVca
6158 $ref: '#/components/requestBodies/EditVcaRequest'
6161 description: Accepted
6165 $ref: '#/components/schemas/OpId'
6168 $ref: '#/components/schemas/OpId'
6170 $ref: '#/components/responses/BadRequest'
6172 $ref: '#/components/responses/Unauthorized'
6174 $ref: '#/components/responses/Forbidden'
6176 $ref: '#/components/responses/NotFound'
6178 $ref: '#/components/responses/MethodNotAllowed'
6180 $ref: '#/components/responses/NotAcceptable'
6182 $ref: '#/components/responses/Conflict'
6184 $ref: '#/components/responses/UnprocessableEntity'
6186 $ref: '#/components/responses/InternalServerError'
6188 $ref: '#/components/responses/ServiceUnavailable'
6190 $ref: '#/components/responses/UnexpectedError'
6192 $ref: '#/components/responses/UnexpectedError'
6197 summary: Delete a VCA
6198 description: Delete a VCA
6199 operationId: deleteVca
6202 description: Accepted
6204 $ref: '#/components/responses/BadRequest'
6206 $ref: '#/components/responses/Unauthorized'
6208 $ref: '#/components/responses/Forbidden'
6210 $ref: '#/components/responses/NotFound'
6212 $ref: '#/components/responses/MethodNotAllowed'
6214 $ref: '#/components/responses/NotAcceptable'
6216 $ref: '#/components/responses/Conflict'
6218 $ref: '#/components/responses/UnprocessableEntity'
6220 $ref: '#/components/responses/InternalServerError'
6222 $ref: '#/components/responses/ServiceUnavailable'
6224 $ref: '#/components/responses/UnexpectedError'
6226 $ref: '#/components/responses/UnexpectedError'
6227 '/admin/v1/k8srepos':
6232 summary: Query information about multiple K8s Repos
6233 description: Query information about multiple K8s Repos
6234 operationId: getK8sRepos
6241 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6244 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6246 $ref: '#/components/responses/BadRequest'
6248 $ref: '#/components/responses/Unauthorized'
6250 $ref: '#/components/responses/Forbidden'
6252 $ref: '#/components/responses/NotFound'
6254 $ref: '#/components/responses/MethodNotAllowed'
6256 $ref: '#/components/responses/NotAcceptable'
6258 $ref: '#/components/responses/Conflict'
6260 $ref: '#/components/responses/UnprocessableEntity'
6262 $ref: '#/components/responses/InternalServerError'
6264 $ref: '#/components/responses/ServiceUnavailable'
6266 $ref: '#/components/responses/UnexpectedError'
6268 $ref: '#/components/responses/UnexpectedError'
6273 summary: Create a new K8s Repo
6274 description: Create a new K8s Repo
6275 operationId: createK8sRepo
6277 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6280 description: Accepted
6284 $ref: '#/components/schemas/ObjectId_plus_OpId'
6287 $ref: '#/components/schemas/ObjectId_plus_OpId'
6289 $ref: '#/components/responses/BadRequest'
6291 $ref: '#/components/responses/Unauthorized'
6293 $ref: '#/components/responses/Forbidden'
6295 $ref: '#/components/responses/NotFound'
6297 $ref: '#/components/responses/MethodNotAllowed'
6299 $ref: '#/components/responses/NotAcceptable'
6301 $ref: '#/components/responses/Conflict'
6303 $ref: '#/components/responses/UnprocessableEntity'
6305 $ref: '#/components/responses/InternalServerError'
6307 $ref: '#/components/responses/ServiceUnavailable'
6309 $ref: '#/components/responses/UnexpectedError'
6311 $ref: '#/components/responses/UnexpectedError'
6312 '/admin/v1/k8srepos/{k8sRepoId}':
6317 description: K8s Repo ID
6325 summary: Query information about an individual K8s Repo
6326 description: Query information about an individual K8s Repo
6327 operationId: getK8sRepo
6334 $ref: '#/components/schemas/K8sRepoInfo'
6337 $ref: '#/components/schemas/K8sRepoInfo'
6339 $ref: '#/components/responses/BadRequest'
6341 $ref: '#/components/responses/Unauthorized'
6343 $ref: '#/components/responses/Forbidden'
6345 $ref: '#/components/responses/NotFound'
6347 $ref: '#/components/responses/MethodNotAllowed'
6349 $ref: '#/components/responses/NotAcceptable'
6351 $ref: '#/components/responses/Conflict'
6353 $ref: '#/components/responses/UnprocessableEntity'
6355 $ref: '#/components/responses/InternalServerError'
6357 $ref: '#/components/responses/ServiceUnavailable'
6359 $ref: '#/components/responses/UnexpectedError'
6361 $ref: '#/components/responses/UnexpectedError'
6366 summary: Delete a K8s Repo
6367 description: Delete a K8s Repo
6368 operationId: deleteK8sRepo
6371 description: Accepted
6373 $ref: '#/components/responses/BadRequest'
6375 $ref: '#/components/responses/Unauthorized'
6377 $ref: '#/components/responses/Forbidden'
6379 $ref: '#/components/responses/NotFound'
6381 $ref: '#/components/responses/MethodNotAllowed'
6383 $ref: '#/components/responses/NotAcceptable'
6385 $ref: '#/components/responses/Conflict'
6387 $ref: '#/components/responses/UnprocessableEntity'
6389 $ref: '#/components/responses/InternalServerError'
6391 $ref: '#/components/responses/ServiceUnavailable'
6393 $ref: '#/components/responses/UnexpectedError'
6395 $ref: '#/components/responses/UnexpectedError'
6399 description: Find out more about OSM
6400 url: 'https://osm.etsi.org/docs/user-guide/'
6405 description: Bad request. The server cannot process the request due to a client error.
6409 $ref: '#/components/schemas/ProblemDetails'
6411 description: Authorization information is missing or invalid.
6415 $ref: '#/components/schemas/ProblemDetails'
6417 description: Not enough permissions to do this operation.
6421 $ref: '#/components/schemas/ProblemDetails'
6423 description: The specified resource was not found.
6427 $ref: '#/components/schemas/ProblemDetails'
6429 description: This method is not supported for the requested resource.
6433 $ref: '#/components/schemas/ProblemDetails'
6435 description: The requested resource content cannot match the Accept headers sent in the request.
6439 $ref: '#/components/schemas/ProblemDetails'
6441 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6445 $ref: '#/components/schemas/ProblemDetails'
6446 UnprocessableEntity:
6447 description: The request was well-formed but was unable to be followed due to semantic errors.
6451 $ref: '#/components/schemas/ProblemDetails'
6452 InternalServerError:
6453 description: Internal server error.
6457 $ref: '#/components/schemas/ProblemDetails'
6459 description: Service temporarily unavailable.
6463 $ref: '#/components/schemas/ProblemDetails'
6465 description: Unexpected error.
6469 $ref: '#/components/schemas/ProblemDetails'
6471 description: VNF Descriptor (plaintext)
6475 $ref: '#/components/schemas/VnfDescriptor'
6477 description: VNF Package (compressed)
6481 $ref: '#/components/schemas/VnfPackage'
6483 description: NS Descriptor (plaintext)
6487 $ref: '#/components/schemas/NsDescriptor'
6489 description: NS Package (compressed)
6493 $ref: '#/components/schemas/NsPackage'
6495 description: NetSlice Template (plaintext)
6499 $ref: '#/components/schemas/NetSliceTemplate'
6501 description: NetSlice Package (compressed)
6505 $ref: '#/components/schemas/NetSlicePackage'
6506 NslcmSubscriptionResponse:
6507 description: NslcmSubscriptionResponse
6511 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6514 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6525 # A free list of key:value pairs
6527 additionalProperties: true
6534 CreateNsdInfoRequest:
6535 # A free list of key:value pairs
6537 additionalProperties: true
6538 NsdInfoModifications:
6540 NS Descriptor Information
6541 Only generic fields (id, name, description) are described
6542 For a full specification of the NS Descriptor see:
6543 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6547 description: NSD Identifier
6550 description: NSD Name
6553 description: NSD Description
6555 AlarmInfoModifications:
6564 description: To enable/disable the alarm.
6567 description: Threshold value of the Alarm
6571 NS Descriptor Information
6572 Only generic fields (_id, id, name, description) are described
6573 For a full specification of the NS Descriptor see:
6574 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6579 Identifier of the onboarded individual NS descriptor
6580 resource. This identifier is allocated by the NFVO.
6585 This identifier, which is allocated by the NSD
6586 designer, identifies the NSD in a globally unique
6587 way. It is copied from the NSD content and shall be
6588 present after the NSD content is on-boarded.
6592 Name of the onboarded NSD. This information is
6593 copied from the NSD content and shall be present
6594 after the NSD content is on-boarded.
6598 Description of the onboarded NSD.
6599 This information is copied from the NSD content.
6607 $ref: '#/components/schemas/NsdInfo'
6623 additionalProperties: true
6633 CreateVnfPkgInfoRequest:
6634 # A free list of key:value pairs
6636 additionalProperties: true
6637 VnfPkgInfoModifications:
6639 VNF Package Information
6640 Only generic fields (id, name, description) are described
6641 For a full specification of the VNF Descriptor see:
6642 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6646 description: VNF Package Identifier
6649 description: VNF Package Name
6652 description: VNF Package description
6656 VNF Package Information
6657 Only generic fields (_id, id, name, description) are described
6658 For a full specification of the VNF Descriptor see:
6659 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6664 Identifier of the VNF package. This identifier is allocated by the NFVO.
6668 description: VNF Package Identifier
6671 description: VNF Package Name
6674 description: VNF Package description
6682 $ref: '#/components/schemas/VnfPkgInfo'
6684 # Substituted by InstantiateNsRequest
6687 NS Instance Information
6688 Only generic fields (_id, id, name, description) are described
6689 For a full specification of the NS Instance see:
6690 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
6694 description: Identifier of the NS instance.
6698 description: Identifier of the NS instance.
6702 description: Human readable name of the NS instance.
6705 description: Human readable description of the NS instance.
6711 InstantiateNsRequest:
6716 Human-readable name of the NS instance to be created.
6720 Identifier of the NSD that defines the NS instance to be created.
6725 Identifier of the VIM Account where the NS instance shall be created.
6744 additionalParamsForNs:
6746 additionalProperties: true
6747 additionalParamsForVnf: &additionalparamsforvnf
6756 additionalProperties: true
6760 use this namespace for all the KDU deployed in this VNF
6761 (if any). By default it is used the id of the project
6762 additionalParamsForVdu:
6771 additionalProperties: true
6775 additionalProperties: false
6776 additionalParamsForKdu:
6785 description: use this namespace for this KDU
6790 additionalProperties: true
6794 additionalProperties: false
6798 additionalProperties: false
6811 To compute automatically the target VIM for each VNF based on
6812 constrains, e.g. latency. Currently only 'PLA' is supported
6813 placement-constraints:
6815 additionalProperties: true
6849 additionalProperties: false
6864 floating-ip-required:
6868 additionalProperties: false
6872 additionalProperties: false
6911 additionalProperties: false
6925 additionalProperties: false
6927 additionalProperties: false
6939 connect additional ports to the created underlay SDN connectivity.
6940 Normally for external connectivy.
6954 additionalProperties: true
6959 additionalProperties: false
6960 internal-connection-point:
6973 additionalProperties: False
6978 additionalProperties: false
6983 additionalProperties: false
7002 additionalProperties: true
7010 additionalProperties: true
7018 additionalProperties: false
7019 vnfd-connection-point-ref:
7024 member-vnf-index-ref:
7026 vnfd-connection-point-ref:
7032 - member-vnf-index-ref
7033 - vnfd-connection-point-ref
7035 additionalProperties: false
7039 additionalProperties: false
7045 additionalProperties: false
7054 description: timeout for the scale operation
7067 scaling-group-descriptor:
7074 - scaling-group-descriptor
7076 additionalProperties: false
7080 additionalProperties: false
7084 additionalProperties: false
7087 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
7088 instance by healing one or more of the VNF that are part of this NS.
7092 description: timeout for the heal operation in seconds
7096 List of VNF to be healed, together with the information needed to heal each.
7099 $ref: "#/components/schemas/HealVnfData"
7104 This type represents the information to heal a VNF that is part of an NS.
7111 Identifies the VNF instance, part of the NS, requiring a
7117 Indicates the reason why a healing procedure is required.
7121 Additional parameters passed by the NFVO as input to
7122 the healing process, specific to the VNF being healed.
7127 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
7132 List of VDU to be healed, together with the information needed to heal each.
7135 $ref: "#/components/schemas/HealVduData"
7138 This type represents the information to heal a VDU that is part of a VNF.
7145 Identifies the VDU id, part of the VNF, requiring a healing action.
7150 Indicates the VDU number when the VDU is part of a scale-group.
7155 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
7158 NSinstanceMigrateRequest:
7160 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
7161 instance by migrating one or more of the VDUs that are part of this NS.
7179 additionalProperties: false
7183 timeout_ns_terminate:
7184 description: timeout for terminate operation
7187 description: remove network service if termination end without error
7189 skip_terminate_primitives:
7190 description: Do not execute network service termination primitives
7192 additionalProperties: false
7196 $ref: '#/components/schemas/NsInstance'
7197 NSinstanceActionRequest:
7203 name of the primitive in the 'config-descriptor'. If the target is
7204 a kdu it can be also 'status', 'rollback' or 'upgrade'
7206 description: parameters of this primitive
7207 $ref: '#/components/schemas/KeyValuePairs'
7210 description: provide if the target action is for a vnf, vdu or kdu
7213 description: provide if the target action is for a vdu
7216 description: provide if the target action is for a kdu
7220 description: timeout for the day 1/2 operation
7225 additionalProperties: false
7228 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
7229 instance by updating one or more of the VNFs that are part of this NS.
7237 - MODIFY_VNF_INFORMATION
7239 changeVnfPackageData:
7249 removeVnfInstanceId:
7283 additionalProperties: false
7286 additionalProperties: false
7287 VerticalscaleNsRequest:
7289 This type represents request parameters for the "Vertical Scale NS" operation.
7290 This operation supports the vertical scale of an NS instance by verticalscaling
7291 one or more of the VNFs that are part of this NS.
7296 changeVnfFlavorData:
7319 additionalProperties: false
7322 additionalProperties: false
7323 # CreateNSinstanceContentRequest:
7324 # Substituted by InstantiateNsRequest
7325 CreateNSinstanceContentResponse:
7348 isAutomaticInvocation:
7390 $ref: '#/components/schemas/NsLcmOpOcc'
7393 VNF Instance Information
7394 Only generic fields (_id, id) are described
7395 For a full specification of the VNF Instance see:
7396 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7405 ArrayOfVnfInstanceInfo:
7408 $ref: '#/components/schemas/VnfInstanceInfo'
7411 NetSlice Template Information
7412 Only generic fields (_id, id, name) are described
7413 For a full specification of the NetSlice Template see:
7414 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7418 description: NetSlice Template Identifier
7422 description: Human readable NetSlice Template Identifier
7425 description: Human readable name of the NetSlice Template
7430 $ref: '#/components/schemas/NstInfo'
7431 CreateNstInfoRequest:
7432 # A free list of key:value pairs
7434 additionalProperties: true
7441 NstInfoModifications:
7443 NetSlice Template Information
7444 Only generic fields (id, name) are described
7445 For a full specification of the NetSlice Template see:
7446 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7450 description: NST Identifier
7453 description: NST Name
7457 NetSlice Instance Information
7458 Only generic fields (_id, id, name, description) are described
7459 For a full specification of the NetSlice Instance see:
7460 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7464 description: Identifier of the NetSlice instance.
7468 description: Identifier of the NetSlice instance.
7472 description: Human readable name of the NetSlice instance.
7475 description: Human readable description of the NetSlice instance.
7481 ArrayOfNetSliceInstance:
7484 $ref: '#/components/schemas/NetSliceInstance'
7491 description: Identifier of the Alarm.
7495 description: Identifier of the Alarm.
7499 description: Alarm metric.
7502 description: Threshold value of the Alarm.
7506 description: Operation to be applied.
7509 description: Action to be taken.
7512 description: Current status of the alarm.
7523 $ref: '#/components/schemas/Alarm'
7525 # Substituted by InstantiateNsiRequest
7526 InstantiateNsiRequest:
7531 Human-readable name of the NetSlice instance to be created.
7535 Identifier of the NST that defines the NetSlice instance to be created.
7540 Identifier of the VIM Account where the NetSlice instance shall be created.
7556 additionalParamsForNsi:
7558 additionalProperties: true
7590 additionalParamsForNs:
7592 additionalProperties: true
7593 additionalParamsForVnf: *additionalparamsforvnf
7632 additionalProperties: false
7647 floating-ip-required:
7651 additionalProperties: false
7655 additionalProperties: false
7694 additionalProperties: false
7708 additionalProperties: false
7710 additionalProperties: false
7718 additionalProperties: false
7719 internal-connection-point:
7732 additionalProperties: False
7737 additionalProperties: false
7742 additionalProperties: false
7761 additionalProperties: true
7769 additionalProperties: true
7777 additionalProperties: false
7778 vnfd-connection-point-ref:
7783 member-vnf-index-ref:
7785 vnfd-connection-point-ref:
7791 - member-vnf-index-ref
7792 - vnfd-connection-point-ref
7794 additionalProperties: false
7798 additionalProperties: false
7800 additionalProperties: false
7819 additionalProperties: true
7822 additionalProperties: false
7828 additionalProperties: false
7829 TerminateNsiRequest:
7834 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7835 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7836 takes place immediately.
7845 $ref: '#/components/schemas/KeyValuePairs'
7854 # CreateNsiContentRequest:
7855 # Substituted by InstantiateNsiRequest
7856 CreateNsiContentResponse:
7879 isAutomaticInvocation:
7926 $ref: '#/components/schemas/NsiLcmOpOcc'
7980 $ref: '#/components/schemas/TokenInfo'
8003 project_role_mappings:
8025 $ref: '#/components/schemas/UserInfo'
8026 ProjectRoleMappings:
8038 additionalProperties: false
8039 ProjectRoleMappingsOpt:
8050 additionalProperties: false
8062 project_role_mappings:
8063 $ref: '#/components/schemas/ProjectRoleMappings'
8067 additionalProperties: false
8074 additionalProperties: true
8077 Array edition keys must start with '$'
8078 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
8088 - $ref: '#/components/schemas/ShortNameList'
8089 - $ref: '#/components/schemas/ArrayEditionSchema'
8090 project_role_mappings:
8091 $ref: '#/components/schemas/ProjectRoleMappings'
8092 add_project_role_mappings:
8093 $ref: '#/components/schemas/ProjectRoleMappings'
8094 remove_project_role_mappings:
8095 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
8151 additionalProperties: false
8207 additionalProperties: false
8217 $ref: '#/components/schemas/QuotasInfo'
8221 $ref: '#/components/schemas/ProjectInfo'
8222 CreateProjectRequest:
8230 $ref: '#/components/schemas/QuotasInfo'
8233 additionalProperties: false
8242 $ref: '#/components/schemas/EditQuotasInfo'
8243 additionalProperties: false
8246 additionalProperties:
8250 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8251 Permission values are either true or false
8252 EditPermissionsInfo:
8254 additionalProperties:
8258 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8259 Permission values are either true, false, or null
8269 $ref: '#/components/schemas/PermissionsInfo'
8273 $ref: '#/components/schemas/RoleInfo'
8280 $ref: '#/components/schemas/PermissionsInfo'
8283 additionalProperties: false
8290 $ref: '#/components/schemas/EditPermissionsInfo'
8291 additionalProperties: false
8322 $ref: '#/components/schemas/VimType'
8337 additionalProperties: true
8343 $ref: '#/components/schemas/VimInfo'
8361 $ref: '#/components/schemas/VimType'
8376 additionalProperties: true
8386 additionalProperties: false
8399 $ref: '#/components/schemas/VimType'
8414 additionalProperties: true
8415 additionalProperties: false
8457 $ref: '#/components/schemas/WimType'
8467 additionalProperties: true
8471 $ref: '#/components/schemas/WimInfo'
8487 $ref: '#/components/schemas/WimType'
8497 additionalProperties: true
8502 additionalProperties: false
8523 additionalProperties: true
8524 additionalProperties: false
8563 - $ref: '#/components/schemas/SdnExtraProperties'
8564 - $ref: '#/components/schemas/SdnBasicProperties'
8568 $ref: '#/components/schemas/SdnInfo'
8571 - $ref: '#/components/schemas/SdnBasicProperties'
8578 additionalProperties: false
8581 - $ref: '#/components/schemas/SdnBasicProperties'
8582 additionalProperties: false
8638 additionalProperties: false
8662 $ref: '#/components/schemas/PduInterfaces'
8666 $ref: '#/components/schemas/PduInfo'
8687 $ref: '#/components/schemas/PduInterfaces'
8692 additionalProperties: false
8713 $ref: '#/components/schemas/PduInterfaces'
8714 additionalProperties: false
8719 additionalProperties: false
8720 K8sClusterDeploymentMethods:
8729 additionalProperties: false
8748 additionalProperties: true
8755 $ref: '#/components/schemas/K8sClusterNetList'
8757 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
8764 ArrayOfK8sClusterInfo:
8767 $ref: '#/components/schemas/K8sClusterInfo'
8768 CreateK8sClusterRequest:
8782 additionalProperties: true
8789 $ref: '#/components/schemas/K8sClusterNetList'
8802 additionalProperties: false
8803 EditK8sClusterRequest:
8812 additionalProperties: true
8819 $ref: '#/components/schemas/K8sClusterNetList'
8826 additionalProperties: false
8860 additionalProperties: true
8864 $ref: '#/components/schemas/VcaInfo'
8895 additionalProperties: true
8906 additionalProperties: false
8932 additionalProperties: true
8933 additionalProperties: false
8950 $ref: '#/components/schemas/K8sRepoType'
8956 description: repository username
8959 description: repository password
8962 description: verify certificates of HTTPS-enabled servers using this CA bundle
8965 description: identify HTTPS client using this SSL certificate file
8968 description: skip tls certificate checks for the repository
8971 description: identify HTTPS client using this SSL key file
8975 $ref: '#/components/schemas/K8sRepoInfo'
8976 CreateK8sRepoRequest:
8984 $ref: '#/components/schemas/K8sRepoType'
8992 additionalProperties: false
8993 NslcmSubscriptionResponse:
9006 NslcmSubscriptionInfo:
9023 $ref: '#/components/schemas/Authenticationschema'
9024 ArrayOfNslcmSubscriptionInfo:
9027 $ref: '#/components/schemas/NslcmSubscriptionInfo'
9028 NsInstanceSubscriptionFilter:
9030 used to identify the network service
9033 - $ref: '#/components/schemas/nsdIds'
9034 - $ref: '#/components/schemas/vnfdIds'
9035 - $ref: '#/components/schemas/pnfdIds'
9036 - $ref: '#/components/schemas/nsInstanceIds'
9037 - $ref: '#/components/schemas/nsInstanceNames'
9061 nsInstanceSubscriptionFilter:
9062 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
9065 If NsLcmOperationOccurrenceNotification is selected then at least operationTypes or states is required. If NsLcmOperationOccurrenceNotification is selected then at least nsComponentTypes, lcmOpName and lcmOpOccStatus is required
9070 - NsIdentifierCreationNotification
9071 - NsIdentifierDeletionNotification
9072 - NsLcmOperationOccurrenceNotification
9073 - NsChangeNotification
9091 - PARTIALLY_COMPLETED
9104 lcmOpNameImpactingNsComponent:
9111 - VNF_SCALE_TO_LEVEL
9112 - VNF_CHANGE_FLAVOUR
9116 - VNF_CHANGE_EXT_CONN
9123 lcmOpOccStatusImpactingNsComponent:
9130 - PARTIALLY_COMPLETED
9133 Authenticationschema:
9147 NslcmSubscriptionRequest:
9151 $ref: '#/components/schemas/Nslcmsubschema'
9156 $ref: '#/components/schemas/Authenticationschema'
9162 CreateNsdInfoRequest:
9166 $ref: '#/components/schemas/CreateNsdInfoRequest'
9169 $ref: '#/components/schemas/CreateNsdInfoRequest'
9170 NsdInfoModifications:
9174 $ref: '#/components/schemas/NsdInfoModifications'
9177 $ref: '#/components/schemas/NsdInfoModifications'
9178 AlarmInfoModifications:
9182 $ref: '#/components/schemas/AlarmInfoModifications'
9185 $ref: '#/components/schemas/AlarmInfoModifications'
9190 $ref: '#/components/schemas/NsDescriptor'
9195 $ref: '#/components/schemas/NsPackage'
9196 CreateVnfPkgInfoRequest:
9200 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9203 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9204 VnfPkgInfoModifications:
9208 $ref: '#/components/schemas/VnfPkgInfoModifications'
9211 $ref: '#/components/schemas/VnfPkgInfoModifications'
9216 $ref: '#/components/schemas/VnfPackage'
9221 $ref: '#/components/schemas/VnfDescriptor'
9223 # Substituted by InstantiateNsRequest
9224 InstantiateNsRequest:
9228 $ref: '#/components/schemas/InstantiateNsRequest'
9231 $ref: '#/components/schemas/InstantiateNsRequest'
9236 $ref: '#/components/schemas/HealNsRequest'
9239 $ref: '#/components/schemas/HealNsRequest'
9240 NSinstanceMigrateRequest:
9244 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9247 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9252 $ref: '#/components/schemas/ScaleNsRequest'
9255 $ref: '#/components/schemas/ScaleNsRequest'
9260 $ref: '#/components/schemas/TerminateNsRequest'
9263 $ref: '#/components/schemas/TerminateNsRequest'
9268 $ref: '#/components/schemas/UpdateNsRequest'
9271 $ref: '#/components/schemas/UpdateNsRequest'
9272 VerticalscaleNsRequest:
9276 $ref: '#/components/schemas/VerticalscaleNsRequest'
9279 $ref: '#/components/schemas/VerticalscaleNsRequest'
9280 # CreateNSinstanceContentRequest:
9281 # Substituted by InstantiateNsRequest
9282 CreateNstInfoRequest:
9286 $ref: '#/components/schemas/CreateNstInfoRequest'
9289 $ref: '#/components/schemas/CreateNstInfoRequest'
9294 $ref: '#/components/schemas/NetSliceTemplate'
9299 $ref: '#/components/schemas/NetSlicePackage'
9300 NstInfoModifications:
9304 $ref: '#/components/schemas/NstInfoModifications'
9307 $ref: '#/components/schemas/NstInfoModifications'
9309 # Substituted by InstantiateNsiRequest
9310 InstantiateNsiRequest:
9314 $ref: '#/components/schemas/InstantiateNsiRequest'
9317 $ref: '#/components/schemas/InstantiateNsiRequest'
9318 TerminateNsiRequest:
9322 $ref: '#/components/schemas/TerminateNsiRequest'
9325 $ref: '#/components/schemas/TerminateNsiRequest'
9330 $ref: '#/components/schemas/NsiActionRequest'
9333 $ref: '#/components/schemas/NsiActionRequest'
9334 # CreateNsiContentRequest:
9335 # Substituted by InstantiateNsiRequest
9340 $ref: '#/components/schemas/CreateTokenRequest'
9343 $ref: '#/components/schemas/CreateTokenRequest'
9348 $ref: '#/components/schemas/CreateUserRequest'
9351 $ref: '#/components/schemas/CreateUserRequest'
9356 $ref: '#/components/schemas/EditUserRequest'
9359 $ref: '#/components/schemas/EditUserRequest'
9360 CreateProjectRequest:
9364 $ref: '#/components/schemas/CreateProjectRequest'
9367 $ref: '#/components/schemas/CreateProjectRequest'
9372 $ref: '#/components/schemas/EditProjectRequest'
9375 $ref: '#/components/schemas/EditProjectRequest'
9380 $ref: '#/components/schemas/CreateRoleRequest'
9383 $ref: '#/components/schemas/CreateRoleRequest'
9388 $ref: '#/components/schemas/EditRoleRequest'
9391 $ref: '#/components/schemas/EditRoleRequest'
9396 $ref: '#/components/schemas/CreateVimRequest'
9399 $ref: '#/components/schemas/CreateVimRequest'
9404 $ref: '#/components/schemas/EditVimRequest'
9407 $ref: '#/components/schemas/EditVimRequest'
9412 $ref: '#/components/schemas/CreateWimRequest'
9415 $ref: '#/components/schemas/CreateWimRequest'
9420 $ref: '#/components/schemas/EditWimRequest'
9423 $ref: '#/components/schemas/EditWimRequest'
9428 $ref: '#/components/schemas/CreateSdnRequest'
9431 $ref: '#/components/schemas/CreateSdnRequest'
9436 $ref: '#/components/schemas/EditSdnRequest'
9439 $ref: '#/components/schemas/EditSdnRequest'
9444 $ref: '#/components/schemas/CreatePduRequest'
9447 $ref: '#/components/schemas/CreatePduRequest'
9452 $ref: '#/components/schemas/EditPduRequest'
9455 $ref: '#/components/schemas/EditPduRequest'
9456 CreateK8sClusterRequest:
9460 $ref: '#/components/schemas/CreateK8sClusterRequest'
9463 $ref: '#/components/schemas/CreateK8sClusterRequest'
9464 EditK8sClusterRequest:
9468 $ref: '#/components/schemas/EditK8sClusterRequest'
9471 $ref: '#/components/schemas/EditK8sClusterRequest'
9476 $ref: '#/components/schemas/CreateVcaRequest'
9479 $ref: '#/components/schemas/CreateVcaRequest'
9484 $ref: '#/components/schemas/EditVcaRequest'
9487 $ref: '#/components/schemas/EditVcaRequest'
9488 CreateK8sRepoRequest:
9492 $ref: '#/components/schemas/CreateK8sRepoRequest'
9495 $ref: '#/components/schemas/CreateK8sRepoRequest'
9496 NslcmSubscriptionRequest:
9500 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9503 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9504 # END REQUEST BODIES